az devops wiki page
Note
このリファレンスは、Azure CLI (バージョン 2.30.0 以降) の azure-devops 拡張機能の一部です。 拡張機能は、az devops wiki page コマンドを初めて実行すると、自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
Wiki ページを管理します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| 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 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 --organization]
[--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
必須のパラメーター
Wiki ページのパス。
Wiki の名前または ID。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
ファイル追加操作のコミット メッセージのコメント。
| プロパティ | 値 |
|---|---|
| 規定値: | Added a new page using Azure DevOps CLI |
Wiki ページのコンテンツ。 --file-path が指定されている場合は無視されます。
組織を自動的に検出します。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
ファイルのエンコード。 --file-path パラメーターと組み合わせて使用されます。
| プロパティ | 値 |
|---|---|
| 規定値: | utf-8 |
| 指定可能な値: | ascii, utf-16be, utf-16le, utf-8 |
ファイルにコンテンツが指定されている場合のファイル入力のパス。
Azure DevOps organization URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。例: https://dev.azure.com/MyOrganizationName/.
プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az devops wiki page delete
ページを削除します。
az devops wiki page delete --path
--wiki
[--comment]
[--detect {false, true}]
[--org --organization]
[--project]
[--yes]
必須のパラメーター
Wiki ページのパス。
Wiki の名前または ID。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
削除操作のコミット メッセージにコメントを付けます。
| プロパティ | 値 |
|---|---|
| 規定値: | Deleted the page using Azure DevOps CLI |
組織を自動的に検出します。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
Azure DevOps organization URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。例: https://dev.azure.com/MyOrganizationName/.
プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です。
確認を求めないでください。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az devops wiki page show
ページのコンテンツを取得するか、ページを開きます。
az devops wiki page show --path
--wiki
[--detect {false, true}]
[--include-content]
[--open]
[--org --organization]
[--project]
[--recursion-level]
[--version]
必須のパラメーター
Wiki ページのパス。
Wiki の名前または ID。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
組織を自動的に検出します。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
ページのコンテンツを含めます。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
Web ブラウザーで Wiki ページを開きます。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
Azure DevOps organization URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。例: https://dev.azure.com/MyOrganizationName/.
プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です。
ページのサブページを含めます。
Wiki ページのバージョン (ETag)。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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 --organization]
[--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
必須のパラメーター
Wiki ページのパス。
編集するファイルのバージョン (ETag)。
Wiki の名前または ID。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
ファイル編集操作のコミット メッセージのコメント。
| プロパティ | 値 |
|---|---|
| 規定値: | Updated the page using Azure DevOps CLI |
Wiki ページのコンテンツ。 --file-path が指定されている場合は無視されます。
組織を自動的に検出します。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
ファイルのエンコード。 --file-path パラメーターと組み合わせて使用されます。
| プロパティ | 値 |
|---|---|
| 規定値: | utf-8 |
| 指定可能な値: | ascii, utf-16be, utf-16le, utf-8 |
ファイルにコンテンツが指定されている場合のファイル入力のパス。
Azure DevOps organization URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。例: https://dev.azure.com/MyOrganizationName/.
プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |