az devops wiki page

  • リファレンス

Note

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

wiki ページを管理します。

コマンド

名前 説明 型 Status
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 page create

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

az devops wiki page create --path
                           --wiki
                           [--comment]
                           [--content]
                           [--detect {false, true}]
                           [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                           [--file-path]
                           [--org]
                           [--project]

例

インライン コンテンツを含む '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

必須のパラメーター

--path

Wiki ページのパス。

--wiki

Wiki の名前または ID。

省略可能のパラメーター

--comment

ファイル追加操作のコミット メッセージ内のコメント。

既定値: Added a new page using Azure DevOps CLI
--content

Wiki ページのコンテンツ。 --file-path が指定されている場合は無視されます。

--detect

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

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

ファイルのエンコード。 --file-path パラメーターと組み合わせて使用されます。

承認された値: ascii, utf-16be, utf-16le, utf-8
既定値: utf-8
--file-path

ファイルにコンテンツが指定されている場合のファイル入力のパス。

--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 を使います。

az devops wiki page delete

ページの削除。

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

必須のパラメーター

--path

Wiki ページのパス。

--wiki

Wiki の名前または ID。

省略可能のパラメーター

--comment

削除操作のコミット メッセージにコメントを付けます。

既定値: Deleted the page using Azure DevOps CLI
--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 page show

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

az devops wiki page show --path
                         --wiki
                         [--detect {false, true}]
                         [--include-content]
                         [--open]
                         [--org]
                         [--project]
                         [--version]

必須のパラメーター

--path

Wiki ページのパス。

--wiki

Wiki の名前または ID。

省略可能のパラメーター

--detect

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

承認された値: false, true
--include-content

ページのコンテンツを含めます。

既定値: False
--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 構成を使用して取得された場合は必須です。

--version -v

Wiki ページのバージョン (ETag)。

グローバル パラメーター
--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 page update

ページを編集します。

az devops wiki page update --path
                           --version
                           --wiki
                           [--comment]
                           [--content]
                           [--detect {false, true}]
                           [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                           [--file-path]
                           [--org]
                           [--project]

例

インライン コンテンツを含む 'myprojectwiki' という名前の wiki のパス 'my page' でページのコンテンツを更新する

az devops wiki page update --path 'my page' --wiki myprojectwiki --content "Hello World"            --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b

Wiki のパス 'my page' でページのコンテンツをファイルのコンテンツで更新する

az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt            --encoding utf-8 --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b

必須のパラメーター

--path

Wiki ページのパス。

--version -v

編集するファイルのバージョン (ETag)。

--wiki

Wiki の名前または ID。

省略可能のパラメーター

--comment

ファイル編集操作のコミット メッセージ内のコメント。

既定値: Updated the page using Azure DevOps CLI
--content

Wiki ページのコンテンツ。 --file-path が指定されている場合は無視されます。

--detect

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

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

ファイルのエンコード。 --file-path パラメーターと組み合わせて使用されます。

承認された値: ascii, utf-16be, utf-16le, utf-8
既定値: utf-8
--file-path

ファイルにコンテンツが指定されている場合のファイル入力のパス。

--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 を使います。