Merge pull request #253901 from dlepow/grpc

[APIM] gRPC API

Author: JamesJBarnett

articles/api-management/api-management-features.md

@@ -49,6 +49,7 @@ Each API Management [pricing tier](https://aka.ms/apimpricing) offers a distinct
 | [Pass-through WebSocket APIs](websocket-api.md)                                                                                    | No          | Yes       | Yes   | Yes      | Yes     |
 | [Pass-through GraphQL APIs](graphql-apis-overview.md)                                                                               | Yes          | Yes       | Yes   | Yes      | Yes     |
 | [Synthetic GraphQL APIs](graphql-apis-overview.md)                                            | Yes           | Yes       | Yes   | Yes      | Yes     |
+| [Pass-through gRPC APIs](grpc-api.md) (preview)                                                                              | No          | Yes       | No   | No      | Yes     |
 
 <sup>1</sup> Enables the use of Microsoft Entra ID (and Azure AD B2C) as an identity provider for user sign in on the developer portal.<br/>
 <sup>2</sup> Including related functionality such as users, groups, issues, applications, and email templates and notifications.<br/>

articles/api-management/api-management-gateways-overview.md

@@ -7,7 +7,7 @@ author: dlepow
 
 ms.service: api-management
 ms.topic: conceptual
-ms.date: 09/18/2023
+ms.date: 11/6/2023
 ms.author: danlep
 ---
 
@@ -100,6 +100,7 @@ The following table compares features available in the managed gateway versus th
 | [Pass-through GraphQL](graphql-apis-overview.md) |  ✔️ | ✔️ | ✔️ |
 | [Synthetic GraphQL](graphql-apis-overview.md)|  ✔️ |  ✔️<sup>1</sup> | ✔️<sup>1</sup> |
 | [Pass-through WebSocket](websocket-api.md) |  ✔️ |  ❌ | ✔️ |
+| [Pass-through gRPC](grpc-api.md) |  ❌ |  ❌ | ✔️ |
 
 <sup>1</sup> Synthetic GraphQL subscriptions (preview) aren't supported.
 

articles/api-management/grpc-api.md

@@ -0,0 +1,76 @@
+---
+title: Import a gRPC API to Azure API Management (preview) | Microsoft Docs
+description: Learn how to import a gRPC service definition as an API to an API Management instance using the Azure portal, ARM template, or bicep template.
+services: api-management
+author: dlepow
+
+ms.service: api-management
+ms.topic: how-to
+ms.date: 10/04/2023
+ms.author: danlep
+ms.custom: 
+---
+# Import a gRPC API (preview)
+
+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. 
+
+To add a gRPC API to API Management, you need to:
+
+* Upload the API's Protobuf (protocol buffer) definition file to API Management
+* Specify the location of your gRPC service
+* Configure the API in API Management
+
+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/).
+
+
+> [!NOTE]
+> * Importing a gRPC API is in preview. Currently, gRPC APIs are only supported in the self-hosted gateway, not the managed gateway for your API Management instance.
+> * Currently, testing gRPC APIs isn't supported in the test console of the Azure portal or in the API Management developer portal.
+
+[!INCLUDE [api-management-availability-premium-dev](../../includes/api-management-availability-premium-dev.md)]
+
+## Prerequisites
+
+* 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).
+
+* 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).
+
+* A gRPC Protobuff (.proto) file available locally and gRPC service that's accessible over HTTPS.
+
+## Add a gRPC API
+
+#### [Portal](#tab/portal)
+
+1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
+
+1. In the left menu, select **APIs** > **+ Add API**.
+
+1. Under **Define a new API**, select **gRPC**.
+
+    :::image type="content" source="./media/grpc-api/grpc-api.png" alt-text="Screenshot of creating a gRPC API in the portal." :::
+
+1. In the **Create a gRPC API window**, select **Full**.
+
+1. For a gRPC API, you must specify the following settings:
+
+    1. In **Upload schema**, select a local .proto file associated with the API to import.
+
+    1. In **gRPC server URL**, enter the address of the gRPC service. The address must be accessible over HTTPS.
+
+    1. In **Gateways**, select the gateway resource that you want to use to expose the API. 
+
+        > [!IMPORTANT]
+        > In public preview, you can only select a self-hosted gateway. The **Managed** gateway isn't supported. 
+
+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.
+
+1. Select **Create**.
+
+    The API is added to the **APIs** list. You can view update your settings by going to the **Settings** tab of the API. 
+
+---
+
+
+[!INCLUDE [api-management-append-apis.md](../../includes/api-management-append-apis.md)]
+
+[!INCLUDE [api-management-define-api-topics.md](../../includes/api-management-define-api-topics.md)]

articles/api-management/media/grpc-api/grpc-api.png

@@ -2,7 +2,7 @@
 author: dlepow
 ms.service: api-management
 ms.topic: include
-ms.date: 11/03/2021
+ms.date: 10/05/2023
 ms.author: danlep
 ---
 ## Related topics
@@ -21,4 +21,5 @@ ms.author: danlep
 * [Import a Service Fabric service](../articles/service-fabric/service-fabric-tutorial-deploy-api-management.md)
 * [Import an OData API](../articles/api-management/import-api-from-odata.md)
 * [Import SAP OData metadata](../articles/api-management/sap-api.md)
+* [Import a gRPC API](../articles/api-management/grpc-api.md)
 * [Edit an API](../articles/api-management/edit-api.md)