Skip to content

Commit 828ffca

Browse files
committed
Final APIM updates
1 parent 603bbf3 commit 828ffca

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed
Binary file not shown.
19.5 KB
Loading

articles/azure-functions/openapi-apim-integrate-visual-studio.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -183,39 +183,43 @@ Before you can publish your project, you must have a function app in your Azure
183183
| **API name** | TurbineRepair | Name for the API. |
184184
| **Subscription name** | Your subscription | The Azure subscription to use. Accept this subscription or select a new one from the drop-down list. |
185185
| **Resource group** | Name of your resource group | Select the same resource group as your function app from the drop-down list. |
186-
| **API Management service** | New instance | Select **New** to create a new API Management instance in the serverless tier. |
186+
| **API Management service** | New instance | Select **New** to create a new API Management instance in the same location in the serverless tier. Select **OK** to create the instance. |
187187
188188
:::image type="content" source="media/openapi-apim-integrate-vs/create-api-management-api.png" alt-text="Create API Management instance with API":::
189189
190190
1. Select **Create** to create the API Management instance with the TurbineRepair API from the function integration.
191191
192-
1. select **Finish**, verify the Publish page says **Ready to publish**, and then select **Publish** to deploy the package containing your project files to your new function app in Azure.
192+
1. Select **Finish** and after the publish profile creation process completes, select **Close**.
193+
194+
1. Verify the Publish page now says **Ready to publish**, and then select **Publish** to deploy the package containing your project files to your new function app in Azure.
193195
194196
After the deployment completes, the root URL of the function app in Azure is shown in the **Publish** tab.
195197
196198
## Get the function access key
197199
198200
1. In the **Publish** tab, select the ellipses (**...**) next to **Hosting** and select **Open in Azure portal**. The function app you created is opened in the Azure portal in your default browser.
199201
200-
1. Under **Functions**, select **Functions** > **TurbineRepair** then select **Function keys**.
202+
1. Under **Functions** on the **Overview page**, select > **Turbine** then select **Function keys**.
201203
202204
:::image type="content" source="media/openapi-apim-integrate-vs/get-function-keys.png" alt-text="Get an access key for the TurbineRepair function":::
203205
204-
1. Under **Function keys**, select **default** and copy the **value**. You can now set this key in API Management so that it can access the function endpoint.
206+
1. Under **Function keys**, select the *copy to clipboard* icon next to the **default** key. You can now set this key you copied in API Management so that it can access the function endpoint.
205207
206208
## Configure API Management
207209
208-
1. In the **Publish** tab, select the ellipses (**...**) next to **Hosting** and select **Open API in Azure portal**. The API Management instance you created is opened in the Azure portal in your default browser. This API Management instance is already linked to your function app.
210+
1. In the function app page, expand **API** and select **API Management**.
209211
210-
1. Under **APIs**, select **OpenAPI Document on Azure Functions** > **POST Run**, then under **Inbound processing** select **Add policy**.
212+
1. If the function app isn't already connected to the new API Management instance, select it under **API Management**, select **API** > **OpenAPI Document on Azure Functions**, make sure **Import functions** is checked, and select **Link API**. Make sure that only **Turbine** is selected for import and then **Select**.
211213

212-
:::image type="content" source="media/openapi-apim-integrate-vs/apim-add-policy.png" alt-text="Add an inbound policy to the API":::
214+
1. Select **Go to API Management** at the top of the page, and in the API Management instance, expand **APIs**.
215+
216+
1. Under **APIs** > **All APIs**, select **OpenAPI Document on Azure Functions** > **POST Run**, then under **Inbound processing** select **Add policy** > **Set query parameters**.
213217

214218
1. Below **Inbound processing**, in **Set query parameters**, type `code` for **Name**, select **+Value**, paste in the copied function key, and select **Save**. API Management includes the function key when it passes calls through to the function endpoint.
215219

216220
:::image type="content" source="media/openapi-apim-integrate-vs/inbound-processing-rule.png" alt-text="Provide Function credentials to the API inbound processing rule":::
217221

218-
Now that the function key is set, you can call the API to verify that it works when hosted in Azure.
222+
Now that the function key is set, you can call the `turbine` API endpoint to verify that it works when hosted in Azure.
219223

220224
## Verify the API in Azure
221225

@@ -236,7 +240,7 @@ Now that the function key is set, you can call the API to verify that it works w
236240

237241
## Download the OpenAPI definition
238242

239-
If your API works as expected, you can download the OpenAPI definition.
243+
If your API works as expected, you can download the OpenAPI definition for the new hosted APIs from API Managment.
240244

241245
1. 1. Under **APIs**, select **OpenAPI Document on Azure Functions**, select the ellipses (**...**), and select **Export**.
242246

0 commit comments

Comments
 (0)