Skip to content

Commit 283b6b3

Browse files
committed
Postman scrub of all Functions docs
1 parent 0c9b2e3 commit 283b6b3

17 files changed

+94
-64
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
119119

120120
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.
121121

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 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.
123123

124124
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:
125125

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ Azure Functions Core Tools gives you the capability to run an Azure Functions pr
373373

374374
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.
375375

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 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.
377377

378378
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:
379379

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

articles/azure-functions/event-grid-how-tos.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ To start receiving Event Grid HTTP requests, you need a subscription to events r
2323

2424
The URL endpoint for your Event Grid triggered function depends on the version of the Functions runtime. The following example shows the version-specific URL pattern:
2525

26-
# [v2.x+](#tab/v2)
26+
#### [v2.x+](#tab/v2)
2727

2828
```http
2929
https://{functionappname}.azurewebsites.net/runtime/webhooks/eventgrid?functionName={functionname}&code={systemkey}
3030
```
3131

32-
# [v1.x](#tab/v1)
32+
#### [v1.x](#tab/v1)
3333

3434
```http
3535
https://{functionappname}.azurewebsites.net/admin/extensions/EventGridExtensionConfig?functionName={functionname}&code={systemkey}
@@ -45,13 +45,13 @@ The URL endpoint you construct includes the system key value. The system key is
4545

4646
You can get the system key by using the following API (HTTP GET):
4747

48-
# [v2.x+](#tab/v2)
48+
#### [v2.x+](#tab/v2)
4949

5050
```
5151
http://{functionappname}.azurewebsites.net/admin/host/systemkeys/eventgrid_extension?code={masterkey}
5252
```
5353

54-
# [v1.x](#tab/v1)
54+
#### [v1.x](#tab/v1)
5555

5656
```
5757
http://{functionappname}.azurewebsites.net/admin/host/systemkeys/eventgridextensionconfig_extension?code={masterkey}
@@ -87,7 +87,7 @@ For more information, see [Authorization keys](functions-bindings-http-webhook-t
8787

8888
You can create an event subscription either from the [Azure portal](https://portal.azure.com) or by using the Azure CLI.
8989

90-
# [Portal](#tab/portal)
90+
#### [Portal](#tab/portal)
9191

9292
For functions that you develop in the Azure portal with the Event Grid trigger, select **Integration** then choose the **Event Grid Trigger** and select **Create Event Grid subscription**.
9393

@@ -99,7 +99,7 @@ When you select this link, the portal opens the **Create Event Subscription** pa
9999

100100
For more information about how to create subscriptions by using the Azure portal, see [Create custom event - Azure portal](../event-grid/custom-event-quickstart-portal.md) in the Event Grid documentation.
101101

102-
# [Azure CLI](#tab/azure-cli)
102+
#### [Azure CLI](#tab/azure-cli)
103103

104104
To create a subscription by using [the Azure CLI](/cli/azure/get-started-with-azure-cli), use the [`az eventgrid event-subscription create`](/cli/azure/eventgrid/event-subscription#az-eventgrid-event-subscription-create) command. Examples use the v2.x+ version of the URL and are written to run in [Azure Cloud Shell](../cloud-shell/overview.md). You'll need to modify the examples to run from a Windows command prompt.
105105

@@ -127,6 +127,10 @@ To test an Event Grid trigger locally, you have to get Event Grid HTTP requests
127127
1. [Generate a request](#generate-a-request) and copy the request body from the viewer app.
128128
1. [Manually post the request](#manually-post-the-request) to the localhost URL of your Event Grid trigger function.
129129

130+
To send an HTTP post request, you need an HTTP test tool, like one of these:
131+
132+
[!INCLUDE [api-test-http-request-tools](../../includes/api-test-http-request-tools.md)]
133+
130134
When you're done testing, you can use the same subscription for production by updating the endpoint. Use the [`az eventgrid event-subscription update`](/cli/azure/eventgrid/event-subscription#az-eventgrid-event-subscription-update) Azure CLI command.
131135

132136
### Create a viewer web app
@@ -162,34 +166,28 @@ The subscription validation request will be received first; ignore any validatio
162166

163167
Run your Event Grid function locally. The `Content-Type` and `aeg-event-type` headers are required to be manually set, while and all other values can be left as default.
164168

165-
Use a tool such as [Postman](https://www.getpostman.com/) or [curl](https://curl.haxx.se/docs/httpscripting.html) to create an HTTP POST request:
169+
Use your HTTP test tool to create an HTTP POST request:
166170

167171
* Set a `Content-Type: application/json` header.
168172
* Set an `aeg-event-type: Notification` header.
169173
* Paste the RequestBin data into the request body.
170-
* Post to the URL of your Event Grid trigger function.
174+
* Send an HTTP POST request to the endpoint that manually starts the Event Grid trigger.
171175

172-
# [v2.x+](#tab/v2)
176+
#### [v2.x+](#tab/v2)
173177

174178
```
175179
http://localhost:7071/runtime/webhooks/eventgrid?functionName={FUNCTION_NAME}
176180
```
177181
178-
# [v1.x](#tab/v1)
182+
#### [v1.x](#tab/v1)
179183
180184
```
181185
http://localhost:7071/admin/extensions/EventGridExtensionConfig?functionName={FUNCTION_NAME}
182186
```
183187
184188
---
185189
186-
The `functionName` parameter must be the name specified in the `FunctionName` attribute.
187-
188-
The following screenshots show the headers and request body in Postman:
189-
190-
![Headers in Postman](media/functions-bindings-event-grid/postman2.png)
191-
192-
![Request body in Postman](media/functions-bindings-event-grid/postman.png)
190+
The `functionName` parameter must be the name specified in the `FunctionName` attribute.
193191
194192
The Event Grid trigger function executes and shows logs similar to the following example:
195193

articles/azure-functions/functions-create-serverless-api.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ Next, test your function to see how it works with the new API surface:
6363

6464
1. Press Enter to confirm that your function is working. You should see the response, "*Hello John*."
6565

66-
1. You can also call the endpoint with another HTTP method to confirm that the function isn't executed. To do so, use a REST client, such as cURL, Postman, or Fiddler.
66+
1. You can also call the endpoint with another HTTP method to confirm that the function isn't executed. To do so, use one of these HTTP test tools:
67+
68+
[!INCLUDE [api-test-http-request-tools](../../includes/api-test-http-request-tools.md)]
6769

6870
## Proxies overview
6971

0 commit comments

Comments
 (0)