Share via

az devops admin banner

  • リファレンス

Note

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

組織のバナーを管理します。

コマンド

名前 説明 型 Status
az devops admin banner add

新しいバナーを追加し、すぐに表示します。

 拡張 GA
az devops admin banner list

バナーを一覧表示します。

 拡張 GA
az devops admin banner remove

バナーを削除します。

 拡張 GA
az devops admin banner show

バナーの詳細を表示します。

 拡張 GA
az devops admin banner update

バナーのメッセージ、レベル、または有効期限を更新します。

 拡張 GA

az devops admin banner add

新しいバナーを追加し、すぐに表示します。

az devops admin banner add --message
                           [--detect {false, true}]
                           [--expiration]
                           [--id]
                           [--org]
                           [--type {error, info, warning}]

必須のパラメーター

--message -m

バナーに表示するメッセージ (文字列)。

省略可能のパラメーター

--detect

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

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

バナーがユーザーに表示されなくなった日付/時刻。 設定しない場合、バナーは自動的に期限切れになりません。削除コマンドを使用して削除する必要があります。 例: "2019-06-10 17:21:00 UTC"、"2019-06-10"。

--id

新しいバナーの識別子。 この識別子は、後でメッセージを変更または削除するために必要です。 一意識別子が指定されていない場合、一意の識別子が自動的に作成されます。

--org --organization

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

--type -t

表示するバナーの種類。 既定値は "info" です。

承認された値: error, info, warning
グローバル パラメーター
--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 admin banner list

バナーを一覧表示します。

az devops admin banner list [--detect {false, true}]
                            [--org]

省略可能のパラメーター

--detect

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

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

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

グローバル パラメーター
--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 admin banner remove

バナーを削除します。

az devops admin banner remove --id
                              [--detect {false, true}]
                              [--org]

必須のパラメーター

--id

削除するバナーの ID。

省略可能のパラメーター

--detect

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

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

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

グローバル パラメーター
--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 admin banner show

バナーの詳細を表示します。

az devops admin banner show --id
                            [--detect {false, true}]
                            [--org]

必須のパラメーター

--id

バナーの識別子。

省略可能のパラメーター

--detect

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

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

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

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

バナーのメッセージ、レベル、または有効期限を更新します。

az devops admin banner update --id
                              [--detect {false, true}]
                              [--expiration]
                              [--message]
                              [--org]
                              [--type {error, info, warning}]

必須のパラメーター

--id

更新するバナーの ID。

省略可能のパラメーター

--detect

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

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

バナーがユーザーに表示されなくなった日付/時刻。 バナーの有効期限の設定を解除するには、この引数に空の値を指定します。 例: "2019-06-10 17:21:00 UTC"、"2019-06-10"。

--message -m

バナーに表示するメッセージ (文字列)。

--org --organization

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

--type -t

表示するバナーの種類。 既定値は "info" です。

承認された値: error, info, warning
グローバル パラメーター
--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 を使います。