How to pass parameter from pipeline to synapse notebook ?

Question

How to pass parameter from pipeline to synapse notebook ?

Lotus88 176

Hi,

I have added based parameter on my notebook from pipeline but I am unsure how I can use them in the notebook. May I know is there a way to use it ? Thanks in advance.

User's image

Smaran Thoomu 23,465 Reputation points Microsoft External Staff Moderator

2025-05-12T12:11:43.1766667+00:00

@Lotus88 We haven’t heard from you on the last response and was just checking back to see if you have a resolution yet. In case if you have any resolution please do share that same with the community as it can be helpful to others. Otherwise, will respond with more details and we will try to help.

2 answers

Your answer

Smaran Thoomu 23,465 Reputation points Microsoft External Staff Moderator

2025-05-12T12:11:43.1766667+00:00

@Lotus88 We haven’t heard from you on the last response and was just checking back to see if you have a resolution yet. In case if you have any resolution please do share that same with the community as it can be helpful to others. Otherwise, will respond with more details and we will try to help.

Answer 1

Nandan Hegde 35,356 MVP Volunteer Moderator

The below link should help :

https://aboutdataai.com.au/2021/07/05/azure-synapse-notebooks-pass-parameter-and-return-output/

Answer 2

Smaran Thoomu 23,465 Microsoft External Staff Moderator

Hi @Lotus88
Yes, you can definitely pass parameters from an Azure Data Factory (or Synapse pipeline) to a Synapse notebook. Here's how you can use them inside the notebook:

In your pipeline, you're already passing a base parameter (as shown in your screenshot).
To access this parameter inside the notebook, use the following syntax in your first code cell:

# Access parameter in Synapse notebook 
p_sysupdate_dt = mssparkutils.notebook.params.get("p_sysupdate_dt")

You can now use this variable (p_sysupdate_dt) in your notebook logic — for example, in date filtering or logging.

Just make sure the parameter name used in the notebook exactly matches the one you set in the pipeline (in this case, p_sysupdate_dt).

Let us know if you need further help!

Lotus88 176 Reputation points

2025-05-20T01:38:11.46+00:00

Hi @Smaran Thoomu

It is not working as I encountered error.

AttributeError: module 'notebookutils.mssparkutils.notebook' has no attribute 'params'
Smaran Thoomu 23,465 Reputation points Microsoft External Staff Moderator

2025-05-20T08:53:40.0333333+00:00
@Lotus88 Thanks for getting back and for sharing the error details.

The error you're seeing:

AttributeError: module 'notebookutils.mssparkutils.notebook' has no attribute 'params'

usually occurs when the notebook environment doesn’t properly recognize the mssparkutils context — this can happen if:

The cell is being executed in a context that doesn’t support pipeline parameter injection (e.g., running the notebook directly from Synapse Studio instead of via pipeline).

The correct import is not used.

To Fix this:

from notebookutils import mssparkutils # Access the pipeline parameter p_sysupdate_dt = mssparkutils.notebook.params.get("p_sysupdate_dt") print(f"Parameter received: {p_sysupdate_dt}")

Ensure you run the notebook via the Synapse pipeline, not directly in Synapse Studio. When you run it directly, pipeline parameters aren’t available, which leads to this error.

Your pipeline setup and parameter binding looks correct in the screenshot (i.e., p_sysupdate_dt being passed from @variables('extract_start_dt')).

Let us know if you're still seeing the error even when running through the pipeline. In that case, please share:

A screenshot of your pipeline activity configuration for the notebook step.

How you’re triggering the pipeline (manual trigger, trigger now, etc.).

Happy to help further!
Lotus88 176 Reputation points

2025-05-20T09:08:42.7633333+00:00

I run the notebook from pipeline.
Smaran Thoomu 23,465 Reputation points Microsoft External Staff Moderator

2025-05-20T13:20:33.1233333+00:00
Lotus88 Thanks for confirming that you're running the notebook from a pipeline.

The error you're seeing - AttributeError: module 'notebookutils.mssparkutils.notebook' has no attribute 'params' - usually means the notebook isn’t running on a Spark pool.

Can you please confirm that your notebook is attached to a Spark pool (not a SQL pool or other kernel)? The mssparkutils.notebook.params.get() method is only available in Spark notebooks.

If you're already using a Spark pool:

Double-check the import and parameter access line:
from notebookutils import mssparkutils p_sysupdate_dt = mssparkutils.notebook.params.get("p_sysupdate_dt")

Also, make sure the parameter name in the pipeline matches exactly - including case.

Let me know if you're still facing issues after verifying the above - happy to assist further.
Lotus88 176 Reputation points

2025-05-21T08:58:12.28+00:00

Hi,

I still encountered same error. I am using spark pool. I have no idea what went wrong?

I am using Trigger Now to run the pipeline.

Operation on target Fail update quotes failed: ^|--------------------------------------------------------------------------- AttributeError Traceback (most recent call last) Cell In[9], line 4 1 from notebookutils import mssparkutils 3 # Pipeline parameter ----> 4 p_sysupdate_dt = mssparkutils.notebook.params.get("p_sysupdate_dt") 5 print(f"p_sysupdate_dt: {p_sysupdate_dt}") AttributeError: module 'notebookutils.mssparkutils.notebook' has no attribute 'params'^|
Smaran Thoomu 23,465 Reputation points Microsoft External Staff Moderator

2025-05-21T09:59:12.29+00:00
Lotus88 Thanks for confirming the setup and sharing the screenshots.

The error you're seeing is due to the incorrect import. You don't need to import mssparkutils manually - it's already available by default in Spark notebooks.

Please update your notebook code like this:

# No import required p_sysupdate_dt = mssparkutils.notebook.params.get("p_sysupdate_dt") print(f"p_sysupdate_dt: {p_sysupdate_dt}")

This should resolve the error.

Let us know if you still face any issues!
Lotus88 176 Reputation points

2025-05-22T10:08:02.7366667+00:00
Hi @Smaran Thoomu

I still encountered error. Based params seems not detected. I even toggle the cell to "Parameter" also cannot work.

Operation on target Fail update quotes failed: ^|---------------------------------------------------------------------------

AttributeError Traceback (most recent call last)

Cell In[7], line 1

----> 1 p_sysupdate_dt = mssparkutils.notebook.params.get("p_sysupdate_dt")

2 print(f"p_sysupdate_dt: {p_sysupdate_dt}")

AttributeError: module 'notebookutils.mssparkutils.notebook' has no attribute 'params'^|
Smaran Thoomu 23,465 Reputation points Microsoft External Staff Moderator

2025-05-22T11:01:49.5+00:00
Lotus88 Thanks for confirming you're using a Spark pool and running the notebook via pipeline trigger.

Based on your screenshots and error message:

AttributeError: module 'notebookutils.mssparkutils.notebook' has no attribute 'params'

It appears the issue is caused by the use of the "Parameters" cell - which is not compatible with pipeline parameter injection - and possibly a leftover import statement that shouldn't be there.

To resolve this:

Do not use the "Parameters" cell toggle

Please remove the “Parameters” tag (highlighted in yellow in your screenshot).

This feature is only for manually entering parameters during interactive notebook runs, not for pipelines.

Use the correct syntax in a normal code cell:

p_sysupdate_dt = mssparkutils.notebook.params.get("p_sysupdate_dt") print(f"p_sysupdate_dt: {p_sysupdate_dt}")

Do not import mssparkutils - it's available by default in Synapse Spark notebooks.

Save the notebook after removing the Parameters toggle and rerun your pipeline using "Trigger now".

Please try the above and let us know if it works - it should solve the issue. Happy to assist further if needed!
Lotus88 176 Reputation points

2025-05-26T01:48:43.47+00:00

Hi @Smaran Thoomu,

I actually tried both methods i.e. without using "Parameters" cell toggle and with "Parameters" cell toggle.

Both methods are not working and I am getting the same error.
Smaran Thoomu 23,465 Reputation points Microsoft External Staff Moderator

2025-05-27T04:10:48.55+00:00

Lotus88 I agree that this issue looks strange and I wasn't able to reproduce this issue. If you have a support plan could you please file a support ticket for deeper investigation and do share the SR# with us? In case if you don't have a support plan please let us know here.
Lotus88 176 Reputation points

2025-05-27T05:21:23.3033333+00:00

I don't have this plan. I don't know why your steps cannot work.

But I tried to use the "Parameters" cell toggle by passing a param from based param to notebook and it is working. I did it with this video below.

https://www.youtube.com/watch?v=ydEXCVVGAiY

Share via

How to pass parameter from pipeline to synapse notebook ?

2 answers

Your answer