Jupyrest
Jupyrest is a service that can run notebooks with predefined input and output contracts.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | LivesiteAutomation |
| URL | https://github.com/microsoft/jupyrest |
| cosmosdbla@microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://github.com/microsoft/jupyrest |
| Privacy policy | https://github.com/microsoft/jupyrest/blob/main/SECURITY.md |
| Categories | Data |
Jupyrest is a service that can run notebooks with predefined input and output contracts.
Prerequisites
You will need the following to use the connector:
- A Juprest instance (Installing the App on Customer Subscription)
- An Azure Active Directory Application
- This is your Juprest client AAD app for submitting request to Juprest service, which is also provided when you create your Juprest instance following above doc.
How to get credentials
Your AAD client app created in the prerequisites has the access to your Jupyrest instance and will be used to create a connection of Jupyrest connector.
Getting Started with your connector
You will need to enter your Jupyrest instance, AAD client ID and client secret to start using the connector.
- For the Jupyrest instance, use the url of your Function App like https://cdbkeplerprod.azurewebsites.net
- For the AAD client ID and secret, use the AAD mentioned in the prerequisites.
- For the ResourceUrl, use the url of your Function App. e.g. https://cdbkeplerprod.azurewebsites.net
Known issues and limitations
"Upload a notebook to Synapse" does not support uploading a existing notebook execution given an excutionId.
Common errors and remedies
Contact us via kepleruser@service.microsoft.com in case of errors and questions.
FAQ
Contact us via kepleruser@service.microsoft.com in case of errors and questions.
Creating a connection
The connector supports the following authentication types:
| Service principal authentication | Use your own Azure Active Directory app for service principal authentication. | All regions | Not shareable |
| Default [DEPRECATED] | This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. | All regions | Not shareable |
Service principal authentication
Auth ID: oauthServicePrincipal
Applicable: All regions
Use your own Azure Active Directory app for service principal authentication.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Client ID | string | True | |
| Client Secret | securestring | True | |
| Tenant | string | True | |
| ResourceUri | string | The resource you are requesting authorization to use. | True |
| Jupyrest instance | string | True |
Default [DEPRECATED]
Applicable: All regions
This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get a notebook execution |
Get a notebook execution. |
| Run a notebook |
Run a notebook. |
| Upload a notebook to Synapse |
Uploads a notebook to Synapse given an existing Execution Id or a set of parameters. |
Get a notebook execution
Get a notebook execution.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
executionId
|
executionId | True | string |
Execution Id |
|
output
|
output | True | boolean |
If true, return notebook's saved output |
|
html
|
html | True | boolean |
If true, return html result in the response |
|
report mode
|
report | boolean |
If true, return report version of execution results (without notebook command cells). |
Returns
- NotebookResponse
- NotebookResponse
Run a notebook
Run a notebook.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
report mode
|
report | boolean |
If true, return report version of execution results (without notebook command cells). |
|
|
parameters
|
parameters | True | dynamic |
Notebook input parameters. |
Returns
- NotebookResponse
- NotebookResponse
Upload a notebook to Synapse
Uploads a notebook to Synapse given an existing Execution Id or a set of parameters.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
parameters
|
parameters | dynamic |
Notebook input parameters. |
Returns
- SynapseResponse
- SynapseResponse
Definitions
NotebookResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
notebook execution id |
|
status
|
status | string |
notebook execution status |
|
notebook
|
notebook | string |
notebook name |
|
parameters
|
parameters | object |
notebook input parameters |
|
output
|
output | array of |
notebook execution output results |
|
html
|
html | string |
notebook html results |
|
start_time
|
start_time | string |
notebook execution start time |
|
end_time
|
end_time | string |
notebook execution end time |
|
exception
|
exception | string |
notebook execution exception |
SynapseResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
|
url | string |
Synapse URL of the created notebook. |