ノードモジュールとして使用する
Deploy CLIは、スタンドアロンのCLIとしてだけでなく、ノードモジュールとしても使用できます。これにより、Auth0リソースを表現豊かなノードスクリプト内で管理できるようになります。
設定の包括的なリストについては、「Deploy CLIを構成する」をお読みください。
dump関数
Auth0テナントからローカルマシンに構成を取得します。
引数パラメーター
format
オプション：yamlまたはdirectory。エクスポートされるリソース構成ファイルのファイル形式を決定します。詳細については、「利用可能なリソース構成形式」をお読みください。
output_folder
パス。構成ファイルを書き込む目的のディレクトリを指定します。
config
オブジェクト。ユーティリティの動作を構成します。詳細については、「Deploy CLIを構成する」をお読みください。
config_file
パス。ユーザー定義の構成ファイル（config.json）を指定します。詳細については、「Deploy CLIを構成する」をお読みください。
export_ids
ブール値。有効にすると、各リソースの識別子フィールドをエクスポートします。デフォルト：false。
env
ブール値。ツールが環境変数を取り込むかどうかを示します。デフォルト：false。
proxy_url
要求をプロキシするためのURL。プロキシを使用している場合にのみこれを設定します。
例
import { dump } from 'auth0-deploy-cli';
dump({
output_folder: './local',
format: 'yaml',
config: {
AUTH0_DOMAIN: '<YOUR_AUTH0_TENANT_DOMAIN>',
AUTH0_CLIENT_ID: '<YOUR_AUTH0_CLIENT_ID>',
AUTH0_CLIENT_SECRET: '<YOUR_AUTH0_CLIENT_SECRET>',
},
})
.then(() => {
console.log('Auth0 configuration export successful');
})
.catch((err) => {
console.log('Error during Auth0 configuration export:', err);
});Was this helpful?
デプロイ機能
ローカルマシンからAuth0テナントに構成を適用します。
引数パラメーター
input_file
パス。リソース構成ファイルの場所を指定します。YAML形式の場合、これはtenant.yamlファイルをポイントします。ディレクトリ形式の場合、これはリソース構成ディレクトリをポイントします。
config
オブジェクト。ユーティリティの動作を構成します。詳細については、「Deploy CLIを構成する」をお読みください。
config_file
パス。ユーザー定義の構成ファイル（config.json）を指定します。詳細については、「Deploy CLIを構成する」をお読みください。
export_ids
ブール値。有効にすると、各リソースの識別子フィールドをエクスポートします。デフォルト：false。
env
ブール値。ツールが環境変数を取り込むかどうかを示します。デフォルト：false。
proxy_url
要求をプロキシするためのURL。プロキシを使用している場合にのみこれを設定します。
例
import { deploy } from 'auth0-deploy-cli';
deploy({
input_file: './local/tenant.yaml',
config: {
AUTH0_DOMAIN: '<YOUR_AUTH0_TENANT_DOMAIN>',
AUTH0_CLIENT_ID: '<YOUR_AUTH0_CLIENT_ID>',
AUTH0_CLIENT_SECRET: '<YOUR_AUTH0_CLIENT_SECRET>',
},
})
.then(() => {
console.log('Auth0 configuration applied to tenant successful');
})
.catch((err) => {
console.log('Error when applying configuration to Auth0 tenant:', err);
});Was this helpful?