CLI として使用する

Auth0 Deploy CLI をスタンドアロンのコマンドラインユーティリティとして使用する方法を説明します。

Deploy CLI は、スタンドアロンのコマンドラインユーティリティとして使用できます。これにより、CI/CD ワークフローで Auth0 テナントの設定を簡単に管理できます。

設定項目の一覧について詳しくは、Deploy CLI の設定を参照してください。

​

export コマンド

Auth0テナントからローカルマシンに設定をエクスポートします。

​

--output_folder, -o

パス。設定ファイルの出力先ディレクトリを指定します。

​

--config_file, -c

パス。ユーザー定義の構成ファイル (config.json) を指定します。詳しくは、Deploy CLI の設定を参照してください。

​

--format, -f

オプション: yaml または directory。エクスポートしたリソース設定ファイルの形式を指定します。詳しくは、利用可能なリソース設定形式を参照してください。

​

--export_ids, -e

ブール値。有効にすると、各リソースの識別子フィールドもエクスポートします。デフォルト: false。

​

--env

ブール値。ツールで環境変数を取り込むかどうかを指定します。既定値: true。

​

--debug

ブール値。より詳細なエラーログを出力します。トラブルシューティング時に役立ちます。デフォルト: false。

​

--proxy_url, -p

リクエストをプロキシ経由で送信するための URL です。プロキシ環境で使用している場合にのみ設定してください。

​

例

​

YAML形式でAuth0テナントの設定を取得する

a0deploy export -c=config.json --format=yaml --output_folder=local

​

Auth0テナント設定をディレクトリ (JSON) 形式で取得する

a0deploy export -c=config.json --format=directory --output_folder=local

​

全アセットの ID を含む Auth0 テナント設定の取得

a0deploy export -c=config.json --format=yaml --output_folder=local --export_ids=true

​

import コマンド

ローカルマシンの設定を Auth0 テナントに適用します。

​

--input_file, -i

パス。リソース設定ファイルの場所を指定します。YAML 形式の場合は tenant.yaml ファイルを、ディレクトリ形式の場合はリソース設定ディレクトリを指定します。

​

--config_file, -c

パス。ユーザー定義の設定ファイル (config.json) を指定します。詳しくは、Deploy CLI の設定を参照してください。

​

--env

ブール値。ツールが環境変数を取り込むかどうかを指定します。既定値: true。

​

--proxy_url, -p

リクエストをプロキシ経由で送信するための URL。プロキシの背後にある場合にのみ設定してください。

​

--debug

ブール値。より詳細なエラーログを有効にします。トラブルシューティング時に役立ちます。デフォルト: false。

​

例

​

YAML形式の設定をデプロイする

a0deploy import -c=config.json --input_file=local/tenant.yaml

​

ディレクトリ形式の設定をデプロイする

a0deploy import -c=config.json --input_file=local

​

環境変数を無視して設定をデプロイ

a0deploy import -c=config.json --input_file=local/tenant.yaml --env=false