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
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.
23
23
24
24
To add a gRPC API to API Management, you need to:
25
25
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.
31
29
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/).
32
31
33
32
> [!NOTE]
34
33
> * Currently, gRPC APIs are only supported in the self-hosted gateway, not the managed gateway for your API Management instance.
35
34
> * 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.
37
36
38
37
## Prerequisites
39
38
40
39
* 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).
41
40
42
41
* 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).
43
42
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.
45
44
46
45
## Add a gRPC API
47
46
48
-
#### [Portal](#tab/portal)
49
-
50
47
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
51
48
52
-
1.In the left menu, select **APIs** > **+ Add API**.
49
+
1.Under **APIs** in the sidebar menu, select **APIs**.
53
50
54
51
1. Under **Define a new API**, select **gRPC**.
55
52
@@ -59,22 +56,22 @@ API Management supports pass-through with the following types of gRPC service me
59
56
60
57
1. For a gRPC API, you must specify the following settings:
61
58
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.
63
62
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.
65
64
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.
67
66
68
67
> [!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.
70
69
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.
72
71
73
72
1. Select **Create**.
74
73
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.
0 commit comments