Skip to content

Commit 5d11a6a

Browse files
authored
Merge pull request #283747 from ggailey777/postman
[Functions][Postman] Cleanup docs security requirement--postman removal
2 parents 9091285 + 30d8bc9 commit 5d11a6a

22 files changed

+157
-113
lines changed

articles/azure-functions/durable/durable-functions-create-portal.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,11 @@ If you are creating JavaScript Durable Functions, you'll need to install the [`d
7676

7777
1. Go back to the **HttpStart** function, choose **Get function Url**, and select the **Copy to clipboard** icon to copy the URL. You use this URL to start the **HelloSequence** function.
7878

79-
1. Use an HTTP tool like Postman or cURL to send a POST request to the URL that you copied. The following example is a cURL command that sends a POST request to the durable function:
79+
1. Use one of these HTTP test tools to send an HTTP POST request to the URL endpoint:
80+
81+
[!INCLUDE [api-test-http-request-tools](../../../includes/api-test-http-request-tools.md)]
82+
83+
The following example is a cURL command that sends a POST request to the durable function:
8084

8185
```bash
8286
curl -X POST https://{your-function-app-name}.azurewebsites.net/api/orchestrators/{functionName} --header "Content-Length: 0"
@@ -94,6 +98,8 @@ If you are creating JavaScript Durable Functions, you'll need to install the [`d
9498
}
9599
```
96100

101+
[!INCLUDE [api-test-http-request-tools-caution](../../../includes/api-test-http-request-tools-caution.md)]
102+
97103
1. Call the `statusQueryGetUri` endpoint URI and you see the current status of the durable function, which might look like this example:
98104

99105
```json

articles/azure-functions/durable/durable-functions-isolated-create-first-csharp.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,15 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
111111

112112
:::image type="content" source="media/durable-functions-create-first-csharp/isolated-functions-vscode-debugging.png" alt-text="Screenshot of the Azure local output window." lightbox="media/durable-functions-create-first-csharp/isolated-functions-vscode-debugging.png":::
113113

114-
1. Use a tool like [Postman](https://www.getpostman.com/) or [cURL](https://curl.haxx.se/) to send an HTTP POST request to the URL endpoint.
114+
1. Use one of these HTTP test tools to send an HTTP POST request to the URL endpoint:
115+
116+
[!INCLUDE [api-test-http-request-tools](../../../includes/api-test-http-request-tools.md)]
115117

116118
The response is the HTTP function's initial result. It lets you know that the Durable Functions app orchestration started successfully. It doesn't yet display the end result of the orchestration. The response includes a few useful URLs.
117119

118120
At this point, your breakpoint in the activity function should be hit because the orchestration has started. Step through it to get a response for the status of the orchestration.
119121

120-
1. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can also continue to use Postman to issue the GET request.
122+
1. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can also continue to use the HTTP test tool to issue the GET request.
121123

122124
The request queries the orchestration instance for the status. You should see that the instance finished and that it includes the outputs or results of the Durable Functions app like in this example:
123125

articles/azure-functions/durable/quickstart-java.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,11 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
355355

356356
:::image type="content" source="media/quickstart-java/maven-functions-run.png" alt-text="Screenshot of Azure local output.":::
357357

358-
1. Use a tool like [Postman](https://www.getpostman.com/) or [cURL](https://curl.haxx.se/) to send an HTTP POST request to the URL endpoint. The response should look similar to the following example:
358+
1. Use an HTTP test tool to send an HTTP POST request to the URL endpoint.
359+
360+
[!INCLUDE [api-test-http-request-tools-caution](../../../includes/api-test-http-request-tools-caution.md)]
361+
362+
The response should look similar to the following example:
359363

360364
```json
361365
{
@@ -369,7 +373,7 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
369373

370374
The response is the HTTP function's initial result. It lets you know that the durable orchestration started successfully. It doesn't yet display the end result of the orchestration. The response includes a few useful URLs. For now, query the status of the orchestration.
371375

372-
1. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can continue to use Postman to issue the GET request.
376+
1. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can continue to use the HTTP test tool to issue the GET request.
373377

374378
The request queries the orchestration instance for the status. You should see that the instance finished and that it includes the outputs or results of the durable function, like in this example:
375379

articles/azure-functions/durable/quickstart-js-vscode.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -261,23 +261,31 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
261261

262262
::: zone pivot="nodejs-model-v3"
263263

264-
5. Use your browser or a tool like [Postman](https://www.getpostman.com/) or [cURL](https://curl.haxx.se/) to send an HTTP POST request to the URL endpoint. Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
264+
5. Use your browser or one of these HTTP test tools to send an HTTP POST request to the URL endpoint:
265+
266+
[!INCLUDE [api-test-http-request-tools](../../../includes/api-test-http-request-tools.md)]
267+
268+
Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
265269

266270
The response is the HTTP function's initial result. It lets you know that the durable orchestration started successfully. It doesn't yet display the end result of the orchestration. The response includes a few useful URLs. For now, query the status of the orchestration.
267271

268272
::: zone-end
269273

270274
::: zone pivot="nodejs-model-v4"
271275

272-
5. Use a tool like [Postman](https://www.getpostman.com/) or [cURL](https://curl.haxx.se/) to send an HTTP POST request to the URL endpoint. Replace the last segment with the name of the orchestrator function (`helloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/helloOrchestrator`.
276+
5. Use your browser or one of these HTTP test tools to send an HTTP POST request to the URL endpoint:
277+
278+
[!INCLUDE [api-test-http-request-tools](../../../includes/api-test-http-request-tools.md)]
279+
280+
Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
273281

274282
The response is the HTTP function's initial result. It lets you know that the durable orchestration started successfully. It doesn't yet display the end result of the orchestration. The response includes a few useful URLs. For now, query the status of the orchestration.
275283

276284
::: zone-end
277285

278286
::: zone pivot="nodejs-model-v3"
279287

280-
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can also continue to use Postman to issue the GET request.
288+
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can also continue to use your HTTP test tool to issue the GET request.
281289

282290
The request queries the orchestration instance for the status. You should see that the instance finished and that it includes the outputs or results of the Durable Functions app, like in this example:
283291

@@ -302,7 +310,7 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
302310

303311
::: zone pivot="nodejs-model-v4"
304312

305-
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can also continue to use Postman to issue the GET request.
313+
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. You can also continue to use your HTTP test tool to issue the GET request.
306314

307315
The request queries the orchestration instance for the status. You should see that the instance finished and that it includes the outputs or results of the Durable Functions app, like in this example:
308316

articles/azure-functions/durable/quickstart-powershell-vscode.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,15 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
155155

156156
:::image type="content" source="media/quickstart-js-vscode/functions-f5.png" alt-text="Screenshot of Azure local output.":::
157157

158-
1. Use a tool like [Postman](https://www.getpostman.com/) or [cURL](https://curl.haxx.se/) to send an HTTP POST request to the URL endpoint. Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
158+
1. Use your browser or one of these HTTP test tools to send an HTTP POST request to the URL endpoint:
159+
160+
[!INCLUDE [api-test-http-request-tools](../../../includes/api-test-http-request-tools.md)]
161+
162+
Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
159163

160164
The response is the HTTP function's initial result. It lets you know that the durable orchestration started successfully. It doesn't yet display the end result of the orchestration. The response includes a few useful URLs. For now, query the status of the orchestration.
161165

162-
1. Copy the URL value for `statusQueryGetUri`, paste it in the browser's address bar, and execute the request. Alternatively, you can also continue to use Postman to issue the GET request.
166+
1. Copy the URL value for `statusQueryGetUri`, paste it in the browser's address bar, and execute the request. You can also continue to use your HTTP test tool to issue the GET request.
163167

164168
The request queries the orchestration instance for the status. You must get an eventual response, which shows the instance completed and includes the outputs or results of the durable function. It looks like this example:
165169

articles/azure-functions/durable/quickstart-python-vscode.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -308,11 +308,15 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
308308

309309
::: zone pivot="python-mode-configuration"
310310

311-
5. In your browser or a tool like [Postman](https://www.getpostman.com/) or [cURL](https://curl.haxx.se/), send an HTTP request to the URL endpoint. Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL must be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
311+
5. Use your browser or one of these HTTP test tools to send an HTTP POST request to the URL endpoint:
312+
313+
[!INCLUDE [api-test-http-request-tools](../../../includes/api-test-http-request-tools.md)]
314+
315+
Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
312316

313317
The response is the HTTP function's initial result. It lets you know that the durable orchestration has started successfully. It doesn't yet display the end result of the orchestration. The response includes a few useful URLs. For now, query the status of the orchestration.
314318

315-
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can also continue to use Postman to issue the GET request.
319+
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. You can also continue to use your HTTP test tool to issue the GET request.
316320

317321
The request queries the orchestration instance for the status. You should see that the instance finished and that it includes the outputs or results of the durable function. It looks similar to this example:
318322

@@ -337,11 +341,15 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
337341

338342
::: zone pivot="python-mode-decorators"
339343

340-
5. Use a tool like [Postman](https://www.getpostman.com/) or [cURL](https://curl.haxx.se/) to send an HTTP POST request to the URL endpoint. Replace the last segment with the name of the orchestrator function (`hello_orchestrator`). The URL must be similar to `http://localhost:7071/api/orchestrators/hello_orchestrator`.
344+
5. Use your browser or one of these HTTP test tools to send an HTTP POST request to the URL endpoint:
345+
346+
[!INCLUDE [api-test-http-request-tools](../../../includes/api-test-http-request-tools.md)]
347+
348+
Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
341349

342350
The response is the HTTP function's initial result. It lets you know that the durable orchestration has started successfully. It doesn't yet display the end result of the orchestration. The response includes a few useful URLs. For now, query the status of the orchestration.
343351

344-
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can also continue to use Postman to issue the GET request.
352+
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. You can also continue to use your HTTP test tool to issue the GET request.
345353

346354
The request queries the orchestration instance for the status. You should see that the instance finished and that it includes the outputs or results of the durable function. It looks similar to this example:
347355

articles/azure-functions/durable/quickstart-ts-vscode.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -263,23 +263,31 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
263263

264264
::: zone pivot="nodejs-model-v3"
265265

266-
5. Use a tool like [Postman](https://www.getpostman.com/) or [cURL](https://curl.haxx.se/) to send an HTTP POST request to the URL endpoint. Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
266+
5. Use your browser or one of these HTTP test tools to send an HTTP POST request to the URL endpoint:
267+
268+
[!INCLUDE [api-test-http-request-tools](../../../includes/api-test-http-request-tools.md)]
269+
270+
Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
267271

268272
The response is the HTTP function's initial result. It lets you know that the durable orchestration started successfully. It doesn't yet display the end result of the orchestration. The response includes a few useful URLs. For now, query the status of the orchestration.
269273

270274
::: zone-end
271275

272276
::: zone pivot="nodejs-model-v4"
273277

274-
5. Use a tool like [Postman](https://www.getpostman.com/) or [cURL](https://curl.haxx.se/) to send an HTTP POST request to the URL endpoint. Replace the last segment with the name of the orchestrator function (`helloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/helloOrchestrator`.
278+
5. Use your browser or one of these HTTP test tools to send an HTTP POST request to the URL endpoint:
279+
280+
[!INCLUDE [api-test-http-request-tools](../../../includes/api-test-http-request-tools.md)]
281+
282+
Replace the last segment with the name of the orchestrator function (`HelloOrchestrator`). The URL should be similar to `http://localhost:7071/api/orchestrators/HelloOrchestrator`.
275283

276284
The response is the HTTP function's initial result. It lets you know that the durable orchestration started successfully. It doesn't yet display the end result of the orchestration. The response includes a few useful URLs. For now, query the status of the orchestration.
277285

278286
::: zone-end
279287

280288
::: zone pivot="nodejs-model-v3"
281289

282-
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can also continue to use Postman to issue the GET request.
290+
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. You can also continue to use your HTTP test tool to issue the GET request.
283291

284292
The request queries the orchestration instance for the status. You should see that the instance finished and that it includes the outputs or results of the durable function. It looks similar to this example:
285293

@@ -304,7 +312,7 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
304312

305313
::: zone pivot="nodejs-model-v4"
306314

307-
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. Alternatively, you can also continue to use Postman to issue the GET request.
315+
6. Copy the URL value for `statusQueryGetUri`, paste it in your browser's address bar, and execute the request. You can also continue to use your HTTP test tool to issue the GET request.
308316

309317
The request queries the orchestration instance for the status. You should see that the instance finished and that it includes the outputs or results of the Durable Functions app. It looks similar to this example:
310318

0 commit comments

Comments
 (0)