ノートブックでパラメーターを使用する

完了

パラメーターを使って、パイプラインからノートブックに変数値を渡すことができます。 パラメーター化すると、ノートブックのコードでハードコーディングされた値を使うより、柔軟性が高くなります。

ノートブックでパラメーターを使用する

ノートブックでパラメーターを定義して使うには、ノートブックのコードで dbutils.widgets ライブラリを使います。

たとえば、次の Python コードでは、folder という名前の変数が定義され、data という既定値が割り当てられています。

dbutils.widgets.text("folder", "data")

パラメーターの値を取得するには、次のように get 関数を使います。

folder = dbutils.widgets.get("folder")

get 関数は、ノートブックに渡された特定のパラメーターの値を取得します。 このようなパラメーターが渡されなかった場合は、前に宣言した変数の既定値が取得されます。

出力値を渡す

ノートブック "に" 渡すことができるパラメーターを使うだけでなく、次に示すように notebook.exit 関数を使うことで、ノートブック "から" 呼び出し元のアプリケーションに値を渡すことができます。

path = "dbfs:/{0}/products.csv".format(folder)
dbutils.notebook.exit(path)

パイプラインでパラメーターの値を設定する

Notebook アクティビティにパラメーター値を渡すには、次に示すように、各パラメーターをアクティビティの基本パラメーターに追加します。

Screenshot of a Notebook activity with a folder parameter.

この例では、パラメーター値が Notebook アクティビティのプロパティとして明示的に指定されています。 "パイプライン" パラメーターを定義し、その値を Notebook アクティビティの基本パラメーターに動的に割り当てることもできます。このようにすると、抽象化のレベルがさらに増えます。

ヒント

Azure Data Factoryでのパラメーターの使用について詳しくは、Azure Data Factory のドキュメント「Azure Data Factory でパラメーター、式、関数を使用する方法」をご覧ください。