az pipelines variable

  • リファレンス

Note

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

パイプライン変数を管理します。

コマンド

名前 説明 型 Status
az pipelines variable create

パイプラインに変数を追加します。

 拡張 GA
az pipelines variable delete

パイプラインから変数を削除します。

 拡張 GA
az pipelines variable list

パイプライン内の変数を一覧表示します。

 拡張 GA
az pipelines variable update

パイプライン内の変数を更新します。

 拡張 GA

az pipelines variable create

パイプラインに変数を追加します。

az pipelines variable create --name
                             [--allow-override {false, true}]
                             [--detect {false, true}]
                             [--org]
                             [--pipeline-id]
                             [--pipeline-name]
                             [--project]
                             [--secret {false, true}]
                             [--value]

必須のパラメーター

--name

変数名。

省略可能のパラメーター

--allow-override

値をキュー時に設定できるかどうかを示します。

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

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

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

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

--pipeline-id

パイプラインの ID。

--pipeline-name

パイプラインの名前。 --pipeline-id パラメーターが指定されている場合は無視されます。

--project -p

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

--secret

変数の値がシークレットかどうかを示します。

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

変数の値。 シークレット変数の場合、--value パラメーターが指定されていない場合は、AZURE_DEVOPS_EXT_PIPELINE_VAR_プレフィックスが付いた環境変数から選択されます。または、ユーザーは標準入力を使用して入力するように求められます。 たとえば、名前付きの MySecret 変数は、環境変数AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecretを使用して入力できます。

グローバル パラメーター
--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 pipelines variable delete

パイプラインから変数を削除します。

az pipelines variable delete --name
                             [--detect {false, true}]
                             [--org]
                             [--pipeline-id]
                             [--pipeline-name]
                             [--project]
                             [--yes]

必須のパラメーター

--name

削除する変数の名前。

省略可能のパラメーター

--detect

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

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

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

--pipeline-id

パイプラインの ID。

--pipeline-name

パイプラインの名前。

--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 pipelines variable list

パイプライン内の変数を一覧表示します。

az pipelines variable list [--detect {false, true}]
                           [--org]
                           [--pipeline-id]
                           [--pipeline-name]
                           [--project]

省略可能のパラメーター

--detect

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

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

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

--pipeline-id

パイプラインの ID。

--pipeline-name

パイプラインの名前。 --pipeline-id パラメーターが指定されている場合は無視されます。

--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 pipelines variable update

パイプライン内の変数を更新します。

az pipelines variable update --name
                             [--allow-override {false, true}]
                             [--detect {false, true}]
                             [--new-name]
                             [--org]
                             [--pipeline-id]
                             [--pipeline-name]
                             [--project]
                             [--prompt-value {false, true}]
                             [--secret {false, true}]
                             [--value]

必須のパラメーター

--name

変数名。

省略可能のパラメーター

--allow-override

値をキュー時に設定できるかどうかを示します。

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

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

承認された値: false, true
--new-name

変数の新しい名前。

--org --organization

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

--pipeline-id

パイプラインの ID。

--pipeline-name

パイプラインの名前。 --pipeline-id パラメーターが指定されている場合は無視されます。

--project -p

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

--prompt-value

環境変数または標準入力によるプロンプトを使用してシークレット変数の値を更新するには、True に設定します。

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

変数の値がシークレットの場合。

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

変数の新しい値。 シークレット変数の場合は、--prompt-value パラメーターを使用して、標準入力を使用して入力するように求められます。 非対話型コンソールの場合は、AZURE_DEVOPS_EXT_PIPELINE_VAR_プレフィックスが付いた環境変数から選択できます。たとえば、名前が付いた MySecret 変数は、環境変数AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecretを使用して入力できます。

グローバル パラメーター
--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 を使います。