次の方法で共有

az synapse pipeline

  • リファレンス

Synapse のパイプラインを管理します。

コマンド

名前 説明 型 Status
az synapse pipeline create

パイプラインを作成します。

 コア GA
az synapse pipeline create-run

パイプラインの実行を作成します。

 コア GA
az synapse pipeline delete

パイプラインを削除します。

 コア GA
az synapse pipeline list

パイプラインを一覧表示します。

 コア GA
az synapse pipeline set

存在するパイプラインを更新します。

 コア 非推奨
az synapse pipeline show

パイプラインを取得します。

 コア GA
az synapse pipeline update

存在するパイプラインを更新します。

 コア GA

az synapse pipeline create

編集

パイプラインを作成します。

az synapse pipeline create --file
                           --name
                           --workspace-name
                           [--no-wait]

例

パイプラインを作成します。 JSON 文字列などの複雑な引数のベスト プラクティスとして、ファイル パスの先頭に "@" を追加するように注意してください。

az synapse pipeline create --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.json"

必須のパラメーター

--file

プロパティは、構文または JSON 文字列を使用して @{path} JSON ファイルから指定できます。

--name -n

パイプライン名。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: 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 synapse pipeline create-run

編集

パイプラインの実行を作成します。

az synapse pipeline create-run --name
                               --workspace-name
                               [--is-recovery {false, true}]
                               [--parameters]
                               [--reference-pipeline-run-id]
                               [--start-activity-name]

例

Pipelines_CreateRun

az synapse pipeline create-run --workspace-name testsynapseworkspace --name "myPipeline" \
  --parameters "{\"OutputBlobNameList\":[\"exampleoutput.csv\"]}"

必須のパラメーター

--name -n

パイプライン名。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--is-recovery

回復モード フラグ。 復旧モードが true に設定されている場合、指定された参照されるパイプラインの実行と、新しい実行が同じ groupId の下にグループ化されます。

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

パイプライン実行のパラメーター。 構文または JSON 文字列を使用して @{path} JSON ファイルから指定できます。

--reference-pipeline-run-id --run-id

再実行するパイプライン実行 ID。 実行 ID を指定すると、指定した実行のパラメーターを使用して新しい実行が作成されます。

--start-activity-name

復旧モードでは、再実行はこのアクティビティから開始されます。 指定しない場合、すべてのアクティビティが実行されます。

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

編集

パイプラインを削除します。

az synapse pipeline delete --name
                           --workspace-name
                           [--no-wait]
                           [--yes]

例

パイプラインを削除します。

az synapse pipeline delete --workspace-name testsynapseworkspace \
  --name testpipeline

必須のパラメーター

--name -n

パイプライン名。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--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 synapse pipeline list

編集

パイプラインを一覧表示します。

az synapse pipeline list --workspace-name

例

パイプラインを一覧表示します。

az synapse pipeline list --workspace-name testsynapseworkspace

必須のパラメーター

--workspace-name

ワークスペース名。

グローバル パラメーター
--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 synapse pipeline set

編集
非推奨

このコマンドは非推奨となり、今後のリリースで削除される予定です。 代わりに 'update' を使用してください。

存在するパイプラインを更新します。

az synapse pipeline set --file
                        --name
                        --workspace-name
                        [--no-wait]

例

存在するパイプラインを更新します。 JSON 文字列などの複雑な引数のベスト プラクティスとして、ファイル パスの先頭に "@" を追加するように注意してください。

az synapse pipeline set --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.json"

必須のパラメーター

--file

プロパティは、構文または JSON 文字列を使用して @{path} JSON ファイルから指定できます。

--name -n

パイプライン名。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: 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 synapse pipeline show

編集

パイプラインを取得します。

az synapse pipeline show --name
                         --workspace-name

例

パイプラインを取得します。

az synapse pipeline show --workspace-name testsynapseworkspace \
  --name testpipeline

必須のパラメーター

--name -n

パイプライン名。

--workspace-name

ワークスペース名。

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

編集

存在するパイプラインを更新します。

az synapse pipeline update --file
                           --name
                           --workspace-name
                           [--no-wait]

例

存在するパイプラインを更新します。 JSON 文字列などの複雑な引数のベスト プラクティスとして、ファイル パスの先頭に "@" を追加するように注意してください。

az synapse pipeline update --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.json"

必須のパラメーター

--file

プロパティは、構文または JSON 文字列を使用して @{path} JSON ファイルから指定できます。

--name -n

パイプライン名。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: 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 を使います。