Circuitのパラメーター
Circuitでのパラメーターの使用方法
この構文を使用すると、ワークフロー内で必要な場所にパラメーターの値を挿入できます。
パラメーターの使用可能な場所
以下の表では、Circuit内のさまざまな状態でプレースホルダーを使用する方法をまとめています。
|
状態の種類 |
使用場所 |
項目／キー名 |
差し込み項目の種類 |
説明 |
|
pass |
result |
result |
string |
pass状態で文字列値を渡すために、この差し込み項目を使用します。 |
|
circuit, function, Webhook |
headers |
headers |
json |
circuit、function、WebhookでJSON形式のヘッダーに対応しています。 |
|
circuit, function, Webhook |
parameters |
parameters |
json |
JSON形式でパラメーターを渡すために使用します。 |
|
branch |
branches |
condition |
string |
分岐ロジックで文字列の条件に対応しています。 |
|
task_engine |
payload |
method |
string |
task_engineのペイロードで、methodを文字列値として定義します。 |
|
task_engine |
payload |
url |
string |
task_engineのペイロードで、URLを文字列として指定できます。 |
|
db_engine |
payload |
database_name |
string |
db_engineのペイロードで、database_nameを設定します。 |
db_engine
ペイロード
クエリ
文字列
DBエンジンのペイロードでクエリを定義するには、文字列を使用します。
ssh_engine
ペイロード
コマンド
文字列
SSHエンジンのペイロードでは、コマンドを文字列として渡します。
powershell_engine
ペイロード
execution_path
文字列
PowerShellエンジンのペイロードの実行パスを定義します。
powershell_engine
ペイロード
コマンド
文字列
PowerShellエンジンのペイロードでは、文字列のコマンドに対応しています。
powershell_engine
ペイロード
変数
JSON
PowerShellエンジンのペイロードで変数を定義するには、JSONを使用します。
add_ad_user
ペイロード
object_name
文字列
ADユーザーのペイロードでオブジェクト名を定義します。
add_ad_user
ペイロード
organization_unit
文字列
ADユーザーのペイロードで組織単位を指定します。
add_ad_user
ペイロード
プロパティ
JSON
ADユーザーのペイロードのプロパティを渡すには、JSONを使用します。
add_ad_computer
ペイロード
object_name
文字列
ADコンピューターのペイロードでは、オブジェクト名を文字列として指定できます。
add_ad_computer
ペイロード
organization_unit
文字列
ADコンピューターのペイロードで組織単位を定義します。
add_ad_computer
payload
properties
json
ADコンピューターのペイロードでは、JSONを使用してプロパティを渡します。
add_ad_group
payload
object_name
string
ADグループのペイロードでは、オブジェクト名を文字列として指定できます。
add_ad_group
payload
organization_unit
string
ADグループのペイロードの組織単位を定義します。
add_ad_group
payload
properties
json
ADグループのペイロードのプロパティにはJSONを使用します。
add_ad_user_to_ad_group
payload
user_name
string
ADユーザーをグループに追加するペイロードで、ユーザー名を指定します。
add_ad_user_to_ad_group
payload
group_name
string
ADでユーザーをグループに関連付けるためのグループ名を定義します。
enable_ad_user
payload
user_name
string
ADユーザーを有効にする際、ユーザー名を文字列として指定できます。
disable_ad_user
payload
user_name
string
ADユーザーを無効にするペイロードで、ユーザー名を指定します。
unlock_ad_user
payload
user_name
string
ADユーザーのロックを解除するためのユーザー名を定義します。
reset_ad_password
payload
user_name
string
ADパスワードをリセットする際、ユーザー名を文字列として指定できます。
reset_ad_password
payload
password
文字列
リセット操作で新しいパスワードを指定するには、文字列を使用します。
read_azure_user
-
principle_name
文字列
Azureユーザーの読み取りでは、principle_nameを文字列として指定できます。
update_azure_user
-
principle_name
文字列
Azureユーザーを更新するためのprinciple_nameを指定します。
update_azure_user
-
user_name
文字列
Azureユーザーの更新では、user_nameを文字列として指定できます。
update_azure_user
-
メール
文字列
Azureユーザーの更新でメールアドレスを指定します。
update_azure_user
-
password
文字列
Azureユーザーの認証情報を更新するためのパスワードを指定します。
delete_azure_user
-
principle_name
文字列
Azureユーザーの削除では、principle_nameを文字列として指定できます。