Azure Data Factory および Synapse Analytics で Fail アクティビティを実行する

  • [アーティクル]

パイプラインで意図的にエラーをスローしたい場合があります。 Lookup アクティビティから一致するデータが返されなかったり、Custom アクティビティが内部エラーで終了したりする場合があります。 理由にかかわらず、パイプラインで Fail アクティビティを使用し、そのエラー メッセージとエラー コードの両方をカスタマイズできるようになりました。

適用対象: Azure Data Factory Azure Synapse Analytics

ヒント

企業向けのオールインワン分析ソリューション、Microsoft Fabric の Data Factory をお試しください。 Microsoft Fabric は、データ移動からデータ サイエンス、リアルタイム分析、ビジネス インテリジェンス、レポートまで、あらゆるものをカバーしています。 無料で新しい試用版を開始する方法について説明します。

UI を使用して Fail アクティビティを作成する

パイプライン内で Fail アクティビティを使用するには、次の手順を実行します。

  1. パイプラインの [アクティビティ] ペイン内で Fail を検索し、Fail アクティビティをパイプライン キャンバスにドラッグします。

  2. キャンバス上で新しい Fail アクティビティ (まだ選択されていない場合)、その [設定] タブの順に選択して、その詳細を編集します。

    Shows the UI for a Fail activity.

  3. 失敗メッセージとエラー コードを入力します。 これらには、リテラル文字列式か、動的な式、関数、システム変数、または他のアクティビティからの出力の任意の組み合わせを使用できます。

構文

{
    "name": "MyFailActivity",
    "type": "Fail",
    "typeProperties": {
        "errorCode": "500",
        "message": "My Custom Error Message"
    }
}

型のプロパティ

プロパティ 説明 使用できる値 必須
name Fail アクティビティの名前。 String はい
type Fail に設定する必要があります。 String はい
message Fail アクティビティで表示されるエラー メッセージ。 実行時に評価される動的コンテンツにすることができます。 String はい
errorCode Fail アクティビティのエラーの種類を分類するエラー コード。 実行時に評価される動的コンテンツにすることができます。 String はい

Fail アクティビティのエラー コードを理解する

Fail アクティビティのエラー メッセージとエラー コードは、通常、ユーザーによって設定されます。 エラー コードの具体的な意味については、パイプラインの開発者にお問い合わせください。 ただし、次のエッジ ケースでは、Azure Data Factory によってエラー メッセージとエラー コードが設定されます。

状況の説明 エラー メッセージ エラー コード
message と errorCode 内の (動的) コンテンツは正しく解釈されました。 ユーザーによって設定されたエラー メッセージ ユーザーによって設定されたエラー コード
message と errorCode の両方の動的コンテンツを解釈できません。 "<activity_name> のエラー メッセージまたはエラー コードを解釈できませんでした" ErrorCodeNotString
message 内の動的コンテンツを文字列として解釈することはできません。 "<activity_name> のエラー メッセージ パラメーターを、文字列として解釈できませんでした" ユーザーによって設定されたエラー コード
message 内の動的コンテンツは、null、空の文字列、または空白に解釈されます。 "<activity_name> のエラー メッセージまたはエラー コードを解釈できませんでした" ユーザーによって設定されたエラー コード
errorCode 内の動的コンテンツを文字列として解釈することはできません。 ユーザーによって設定されたエラー メッセージ ErrorCodeNotString
errorCode 内の動的コンテンツは、null、空の文字列、または空白に解釈されます。 ユーザーによって設定されたエラー メッセージ ErrorCodeNotString
ユーザーによって指定された message または errorCode の値には、文字列を使用できません。* パイプラインは、"プロパティ <errorCode/message> の値が無効である" ために "失敗" しました
message フィールドがありません。* "失敗メッセージが指定されませんでした" ユーザーによって設定されたエラー コード
errorCode フィールドがありません。* ユーザーによって設定されたエラー メッセージ ErrorCodeNotString

* パイプラインが Data Factory の Web ユーザー インターフェイス (UI) を使用して開発されている場合、この状況は発生しません。

関連するコンテンツ

サポートされている他の制御フロー アクティビティを参照してください。