az devops wiki

  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.30.0 以降) の azure-devops 拡張機能の一部です。 拡張機能は、az devops wiki コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

wiki を管理します。

コマンド

名前 説明 型 Status
az devops wiki create

Wiki を作成します。

 拡張 GA
az devops wiki delete

Wiki を削除します。

 拡張 GA
az devops wiki list

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

 拡張 GA
az devops wiki page

wiki ページを管理します。

 拡張 GA
az devops wiki page create

新しいページを追加します。

 拡張 GA
az devops wiki page delete

ページの削除。

 拡張 GA
az devops wiki page show

ページのコンテンツを取得するか、ページを開きます。

 拡張 GA
az devops wiki page update

ページを編集します。

 拡張 GA
az devops wiki show

Wiki の詳細を表示します。

 拡張 GA

az devops wiki create

Wiki を作成します。

az devops wiki create [--detect {false, true}]
                      [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--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

省略可能のパラメーター

--detect

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

承認された値: false, true
--mapped-path

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

--name

新しい Wiki の名前。

--org --organization

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

--project -p

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

--repository -r

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

--type --wiki-type

作成する Wiki の種類。

承認された値: codewiki, projectwiki
既定値: projectwiki
--version -v

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

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az devops wiki delete

Wiki を削除します。

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

必須のパラメーター

--wiki

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

省略可能のパラメーター

--detect

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

承認された値: false, true
--org --organization

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

--project -p

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

--yes -y

確認のダイアログを表示しません。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az devops wiki list

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

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

例

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

az devops wiki list

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

az devops wiki list --scope organization

省略可能のパラメーター

--detect

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

承認された値: false, true
--org --organization

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

--project -p

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

--scope

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

承認された値: organization, project
既定値: project
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az devops wiki show

Wiki の詳細を表示します。

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

必須のパラメーター

--wiki

Wiki の名前または ID。

省略可能のパラメーター

--detect

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

承認された値: false, true
--open

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

既定値: False
--org --organization

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

--project -p

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

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。