Skip to content

Commit b0660b2

Browse files
authored
Merge pull request #306540 from cdpark/refresh-azure-api-grpc
Freshness - Azure API - gRPC
2 parents 800a086 + 7e0b1b1 commit b0660b2

1 file changed

Lines changed: 17 additions & 20 deletions

File tree

articles/api-management/grpc-api.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 05/06/2024
9+
ms.date: 10/06/2025
1010
ms.author: danlep
1111
ms.custom:
1212
- devx-track-arm-template
@@ -19,37 +19,34 @@ ms.custom:
1919

2020
[!INCLUDE [api-management-availability-premium-dev](../../includes/api-management-availability-premium-dev.md)]
2121

22-
This article shows how to import a gRPC service definition as an API in API Management. You can then manage the API in API Management, secure access and apply other polices, and pass gRPC API requests through the gateway to the gRPC backend.
22+
This article shows how to import a gRPC service definition as an API in API Management. You can then manage the API in API Management, secure access and apply other policies, and pass gRPC API requests through the gateway to the gRPC backend.
2323

2424
To add a gRPC API to API Management, you need to:
2525

26-
* Upload the API's Protobuf (protocol buffer) definition file to API Management
27-
* Specify the location of your gRPC service
28-
* Configure the API in API Management
29-
30-
API Management supports pass-through with the following types of gRPC service methods: unary, server streaming, client streaming, and bidirectional streaming. For background about gRPC, see [Introduction to gRPC](https://grpc.io/docs/what-is-grpc/introduction/).
26+
* Upload the API's protobuf (protocol buffer) definition file to API Management.
27+
* Specify the location of your gRPC service.
28+
* Configure the API in API Management.
3129

30+
API Management supports pass-through with the following types of gRPC service methods: unary, server streaming, client streaming, and bidirectional streaming. To learn more about gRPC, see [Introduction to gRPC](https://grpc.io/docs/what-is-grpc/introduction/).
3231

3332
> [!NOTE]
3433
> * Currently, gRPC APIs are only supported in the self-hosted gateway, not the managed gateway for your API Management instance.
3534
> * Currently, testing gRPC APIs isn't supported in the test console of the Azure portal or in the API Management developer portal.
36-
> * Import is limited to a single Protobuff (.proto) file.
35+
> * Import is limited to a single protobuf (*.proto*) file.
3736
3837
## Prerequisites
3938

4039
* An API Management instance. If you don't already have one, complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md).
4140

4241
* A gateway resource provisioned in your instance. If you don't already have one, see [Provision a self-hosted gateway in Azure API Management](api-management-howto-provision-self-hosted-gateway.md).
4342

44-
* A gRPC Protobuff (.proto) file available locally and gRPC service that's accessible over HTTPS.
43+
* A gRPC protobuf (*.proto*) file available locally, and gRPC service that's accessible over HTTPS.
4544

4645
## Add a gRPC API
4746

48-
#### [Portal](#tab/portal)
49-
5047
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
5148

52-
1. In the left menu, select **APIs** > **+ Add API**.
49+
1. Under **APIs** in the sidebar menu, select **APIs**.
5350

5451
1. Under **Define a new API**, select **gRPC**.
5552

@@ -59,22 +56,22 @@ API Management supports pass-through with the following types of gRPC service me
5956

6057
1. For a gRPC API, you must specify the following settings:
6158

62-
1. In **Upload schema**, select a local .proto file associated with the API to import.
59+
1. Enter a display name.
60+
61+
1. For **Upload schema**, select a local *.proto* file associated with the API to import.
6362

64-
1. In **gRPC server URL**, enter the address of the gRPC service. The address must be accessible over HTTPS.
63+
1. For **gRPC server URL**, enter the address of the gRPC service. The address must be accessible over HTTPS.
6564

66-
1. In **Gateways**, select the gateway resource that you want to use to expose the API.
65+
1. For **Gateways**, select the gateway resource that you want to use to expose the API.
6766

6867
> [!IMPORTANT]
69-
> In public preview, you can only select a self-hosted gateway. The **Managed** gateway isn't supported.
68+
> In public preview, you can only select a self-hosted gateway. The **Managed** gateway isn't supported.
7069
71-
1. Enter remaining settings to configure your API. These settings are explained in the [Import and publish your first API](import-and-publish.md#import-and-publish-a-backend-api) tutorial.
70+
1. Enter any remaining settings to configure your API. These settings are explained in the [Import and publish your first API](import-and-publish.md#import-and-publish-a-backend-api) tutorial.
7271

7372
1. Select **Create**.
7473

75-
The API is added to the **APIs** list. You can view update your settings by going to the **Settings** tab of the API.
76-
77-
---
74+
The API is added to the **APIs** list. You can view update your settings by going to the **Settings** tab of the API.
7875

7976
## Call gRPC services with .NET
8077

0 commit comments

Comments
 (0)