You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/big-data-cluster/app-consume.md
+3-27Lines changed: 3 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Consume an application deployed on SQL Server Big Data Clusters usi
5
5
author: HugoMSFT
6
6
ms.author: hudequei
7
7
ms.reviewer: wiassaf
8
-
ms.date: 06/22/2020
8
+
ms.date: 08/06/2024
9
9
ms.service: sql
10
10
ms.subservice: big-data-cluster
11
11
ms.topic: conceptual
@@ -105,7 +105,7 @@ To access the RESTful web service for the app you've deployed you first have to
105
105
106
106
> For version information, see [Release history](release-notes-big-data-cluster.md#release-history).
107
107
108
-
Open the appropriate URL in your browser using the IP address and port you retrieved running the [`describe`](#retrieve-the-endpoint) command above. Sign in with the same credentials you used for `azdata login`.
108
+
Open the appropriate URL in your browser using the IP address and port you retrieved running the [`describe`](#retrieve-the-endpoint) command. Sign in with the same credentials you used for `azdata login`.
109
109
110
110
Paste the contents of the `swagger.json` into the [Swagger Editor](https://editor.swagger.io) to understand what methods are available:
111
111
@@ -117,17 +117,11 @@ Notice the `app` is GET method and to get the `token` would use POST method. Sin
117
117
https://10.1.1.3 :30080/api/v1/token
118
118
```
119
119
120
-
121
-
Here is an example of how to do just that in [Postman](https://www.getpostman.com/):
The output of this request will give you a JWT `access_token`, which you'll need to call the URL to run the app.
127
121
128
122
## Execute the app using the RESTful web service
129
123
130
-
There are multiple ways to consume an app on SQL Server Big Data Clusters, you can choose to use [azdata app run command](app-create.md). This section will demonstrate how to use common developer tools such as Postman to execute the app.
124
+
There are multiple ways to consume an app on SQL Server Big Data Clusters, you can choose to use [azdata app run command](app-create.md).
131
125
132
126
You can open the URL for the `swagger` that was returned when you ran `azdata app describe --name [appname] --version [version]` in your browser, which should be similar to `https://[IP]:[PORT]/app/[appname]/[version]/swagger.json`.
133
127
@@ -138,24 +132,6 @@ You can open the URL for the `swagger` that was returned when you ran `azdata ap
138
132
azdata app describe --name add-app --version v1
139
133
```
140
134
141
-
The contents of the `swagger.json` you can paste into [Swagger Editor](https://editor.swagger.io). You'll see that the web service exposes the `run` method, and underneath it went through application proxy, which is a web API that authenticates users and then routes the requests through to the applications. Notice that the Base URL displayed at the top. You can use tool of your choice to call the `run` method (`https://[IP]:30778/api/app/[appname]/[version]/run`), passing in the parameters in the body of your POST request as json.
142
-
143
-
144
-
In this example, we'll use [Postman](https://www.getpostman.com/). Before making the call, you'll need to set the `Authorization` to `Bearer Token` and paste in the token you retrieved earlier. This will set a header on your request. See the screenshot below.
145
-
146
-

147
-
148
-
Next, in the requests body, pass in the parameters to the app you're calling and set the `content-type` to `application/json`:
149
-
150
-

151
-
152
-
When you send the request, you'll get the same output as you did when you ran the app through `azdata app run`:
153
-
154
-

155
-
156
-
You've now successfully called the app through the web service. You can follow similar steps to integrate this web service in your application.
157
-
158
-
159
135
## Next steps
160
136
161
137
Explore how to [Monitor applications on big data clusters](app-monitor.md) for more information. You can also check out additional samples at [App Deploy Samples](https://aka.ms/sql-app-deploy).
0 commit comments