Merge pull request #112394 from vladvino/sputnik-ga

APIM: self-hosted API gateway changes

Author: American-Dipper

.openpublishing.redirection.json

@@ -32081,6 +32081,16 @@
       "redirect_url": "/azure/api-management/mock-api-responses",
       "redirect_document_id": false
     },
+    {
+      "source_path": "articles/api-management/api-management-howto-deploy-self-hosted-gateway-to-k8s.md",
+      "redirect_url": "/azure/api-management/how-to-deploy-self-hosted-gateway-kubernetes",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "articles/api-management/api-management-howto-deploy-self-hosted-gateway-to-docker.md",
+      "redirect_url": "/azure/api-management/how-to-deploy-self-hosted-gateway-docker",
+      "redirect_document_id": false
+    },
     {
       "source_path": "articles/container-service/kubernetes/container-service-deploy-spring-boot-app-on-kubernetes.md",
       "redirect_url": "/java/azure/spring-framework/deploy-spring-boot-java-app-on-kubernetes",

articles/api-management/TOC.yml

@@ -102,12 +102,14 @@
               href: api-management-howto-deploy-multi-region.md
             - name: Provision a self-hosted gateway
               href: api-management-howto-provision-self-hosted-gateway.md
+            - name: Deploy a self-hosted gateway to Azure Kubernetes Service
+              href: how-to-deploy-self-hosted-gateway-azure-kubernetes-service.md
             - name: Deploy a self-hosted gateway to Kubernetes
-              href: api-management-howto-deploy-self-hosted-gateway-to-k8s.md
+              href: how-to-deploy-self-hosted-gateway-kubernetes.md
             - name: Deploy a self-hosted gateway to Docker
-              href: api-management-howto-deploy-self-hosted-gateway-to-docker.md
+              href: how-to-deploy-self-hosted-gateway-docker.md
             - name: Configure custom domain for self-hosted gateway
-              href: api-management-howto-configure-custom-domain-gateway.md            
+              href: api-management-howto-configure-custom-domain-gateway.md
       - name: Cache
         items:
             - name: Add caching to improve performance
@@ -218,6 +220,12 @@
               href: api-management-howto-log-event-hubs.md
             - name: Log requests with Azure Application Insights
               href: api-management-howto-app-insights.md
+            - name: Configure cloud metrics and logs for self-hosted gateway
+              href: how-to-configure-cloud-metrics-logs.md
+            - name: Configure local metrics and logs for self-hosted gateway
+              href: how-to-configure-local-metrics-logs.md
+            - name: Log requests with Azure Application Insights
+              href: api-management-howto-app-insights.md
             - name: Set up DR using backup/restore
               href: api-management-howto-disaster-recovery-backup-restore.md
             - name: Manage user accounts

articles/api-management/add-api-manually.md

@@ -11,7 +11,7 @@ ms.service: api-management
 ms.workload: mobile
 ms.tgt_pltfrm: na
 ms.topic: tutorial
-ms.date: 08/27/2018
+ms.date: 04/20/2020
 ms.author: apimpm
 
 ---
@@ -32,24 +32,14 @@ Complete the following quickstart: [Create an Azure API Management instance](get
 
 ## Create an API
 
-1. Select **APIs** from under **API MANAGEMENT**.
+1. Navigate to your API Management service in the Azure portal and select **APIs** from the menu.
 2. From the left menu, select **+ Add API**.
-3. Select **Blank API** from the list.
-
-    ![Blank API](media/add-api-manually/blank-api.png)
-4. Enter settings for the API.
-
-    |**Name**|**Value**|**Description**|
-    |---|---|---|
-    |**Display name**|*Blank API*|This name is displayed in the Developer portal.|
-    |**Name**|*blank-api*|Provides a unique name for the API.|
-    |**Web Service URL** (optional)|*https://httpbin.org*| If you want to mock an API, you might not enter anything. <br/>In this case, we enter [https://httpbin.org](https://httpbin.org). This is a public testing service. <br/>If you want to import an API that is mapped to a back end automatically, see one of the topics in the [related topics](#related-topics) section.|
-    |**URL scheme**|*HTTPs*|In this case, even though the back end has non-secure HTTP access, we specify a secure HTTPS APIM access to the back end. <br/>This kind of scenario (HTTPS to HTTP) is called HTTPS termination. You might do it if your API exists within a virtual network (where you know the access is secure even if HTTPS is not used). <br/>You might want to use "HTTPS termination" to save on some CPU cycles.|
-    |**URL suffix**|*hbin*| The suffix is a name that identifies this specific API in this APIM instance. It has to be unique in this APIM instance.|
-    |**Products**|*Unlimited*|Publish the API by associating the API with a product. If you want for the API to be published and be available to developers, add it to a product. You can do it during API creation or set it later.<br/><br/>Products are associations of one or more APIs. You can include a number of APIs and offer them to developers through the developer portal. <br/>Developers must first subscribe to a product to get access to the API. When they subscribe, they get a subscription key that is good for any API in that product. If you created the APIM instance, you are an administrator already, so you are subscribed to every product by default.<br/><br/> By default, each API Management instance comes with two sample products: **Starter** and **Unlimited**.| 
+3. Select **Blank API** from the list.  
+    ![Blank API](media/add-api-manually/blank-api.png)  
+4. Enter settings for the API. The settings are explained in the [Import and publish your first API](import-and-publish.md#-import-and-publish-a-backend-api) tutorial.
 5. Select **Create**.
 
-At this point, you have no operations in APIM that map to the operations in your back-end API. If you call an operation that is exposed through the back end but not through the APIM, you get a **404**.
+At this point, you have no operations in API Management that map to the operations in your back-end API. If you call an operation that is exposed through the back end but not through the API Management, you get a **404**.
 
 >[!NOTE] 
 > By default, when you add an API, even if it is connected to some back-end service, APIM will not expose any operations until you whitelist them. To whitelist an operation of your back-end service, create an APIM operation that maps to the back-end operation.

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

@@ -43,4 +43,4 @@ Each API Management [pricing tier](https://aka.ms/apimpricing) offers a distinct
 
 <sup>1</sup> Enables the use of Azure AD (and Azure AD B2C) as an identity provider for user sign in on the developer portal.<br/>
 <sup>2</sup> Including related functionality e.g. users, groups, issues, applications and email templates and notifications.<br/>
-<sup>3</sup> Limited to a single self-hosted gateway deployment with a single gateway node.<br/>
+<sup>3</sup> In the Developer tier self-hosted gateways are limited to single gateway node.<br/>

articles/api-management/api-management-howto-cache-external.md

@@ -9,24 +9,23 @@ editor: ''
 
 ms.assetid: 740f6a27-8323-474d-ade2-828ae0c75e7a
 ms.service: api-management
-ms.workload: mobile
-ms.tgt_pltfrm: na
 ms.topic: conceptual
-ms.date: 05/15/2019
+ms.date: 04/26/2020
 ms.author: apimpm
 
 ---
 
-# Use an external Azure Cache for Redis in Azure API Management
+# Use an external Redis-compatible cache in Azure API Management
 
-In addition to utilizing the built-in cache, Azure API Management also allows for caching responses in an external Azure Cache for Redis.
+In addition to utilizing the built-in cache, Azure API Management allows for caching responses in an external Redis-compatible cache, e.g. Azure Cache for Redis.
 
-Using an external cache allows to overcome a few limitations of the built-in cache. It is especially beneficial if you would like to:
+Using an external cache allows to overcome a few limitations of the built-in cache:
 
 * Avoid having your cache periodically cleared during API Management updates
 * Have more control over your cache configuration
 * Cache more data than your API Management tier allows to
 * Use caching with the Consumption tier of API Management
+* Enable caching in the [API Management self-hosted gateways](self-hosted-gateway-overview.md)
 
 For more detailed information about caching, see [API Management caching policies](api-management-caching-policies.md) and  [Custom caching in Azure API Management](api-management-sample-cache-by-key.md).
 
@@ -50,14 +49,18 @@ This section explains how to create an Azure Cache for Redis in Azure. If you al
 
 [!INCLUDE [redis-cache-create](../../includes/redis-cache-create.md)]
 
+## <a name="create-cache"> </a> Deploy Redis cache to Kubernetes
+
+For caching, self-hosted gateways rely exclusively on external caches. For caching to be effective self-hosted gateways and the cache they rely on must be located close to each other to minimize lookup and store latencies. Deploying a Redis cache into the same Kubernetes cluster or in a separate cluster nearby are the best options. Follow this [link](https://github.com/kubernetes/examples/tree/master/guestbook) to learn how to deploy Redis cache to a Kubernetes cluster.
+
 ## <a name="add-external-cache"> </a>Add an external cache
 
 Follow the steps below to add an external Azure Cache for Redis in Azure API Management.
 
 ![Bring your own cache to APIM](media/api-management-howto-cache-external/add-external-cache.png)
 
 > [!NOTE]
-> The **Use from** setting specifies which API Management regional deployment will communicate with the configured cache in case of a multi-regional configuration of API Management. The caches specified as **Default** will be overridden by caches with a regional value.
+> The **Use from** setting specifies an Azure region or a self-hosted gateway location that will use the configured cache. The caches configured as **Default** will be overridden by caches with a specific matching region or location value.
 >
 > For example, if API Management is hosted in the East US, Southeast Asia and West Europe regions and there are two caches configured, one for **Default** and one for **Southeast Asia**, API Management in **Southeast Asia** will use its own cache, while the other two regions will use the **Default** cache entry.
 
@@ -80,6 +83,16 @@ Follow the steps below to add an external Azure Cache for Redis in Azure API Man
 6. Provide your Azure Cache for Redis connection string in the **Connection string** field.
 7. Click **Save**.
 
+### Add a Redis cache to a self-hosted gateway
+
+1. Browse to your API Management instance in the Azure portal.
+2. Select the **External cache** tab from the menu on the left.
+3. Click the **+ Add** button.
+4. Select **Custom** in the **Cache instance** dropdown field.
+5. Specify the desired self-hosted gateway location or **Default** in the **Use from** dropdown field.
+6. Provide your Redis cache connection string in the **Connection string** field.
+7. Click **Save**.
+
 ## Use the external cache
 
 Once the external cache is configured in Azure API Management, it can be used through caching policies. See [Add caching to improve performance in Azure API Management](api-management-howto-cache.md) for detailed steps.

articles/api-management/api-management-howto-configure-custom-domain-gateway.md

@@ -11,17 +11,14 @@ editor: ''
 ms.service: api-management
 ms.workload: integration
 ms.topic: article
-ms.date: 10/31/2019
+ms.date: 03/31/2020
 ms.author: apimpm
 ---
 
 # Configure a custom domain name
 
 When you provision a [self-hosted Azure API Management gateway](self-hosted-gateway-overview.md) it is not assigned host name and has to be referenced by its IP address. This article shows how to map an existing custom DNS name (also referred to as hostname) a self-hosted gateway.
 
-> [!NOTE]
-> Self-hosted gateway feature is in preview. During the preview, the self-hosted gateway is available only in the Developer and Premium tiers at no additional charge. Developer tier is limited to a single self-hosted gateway deployment.
-
 ## Prerequisites
 
 To perform the steps described in this article, you must have:
@@ -42,7 +39,7 @@ To perform the steps described in this article, you must have:
 
 1. Select **Certificates** from under **Security**.
 2. Select **+ Add**.
-3. Enter a resource name for the certificate into **Id** field.
+3. Enter a resource name for the certificate into **ID** field.
 4. Select the file containing the certificate (.PFX) by selecting the **Certificate** field or the folder icon adjacent to it.
 5. Enter the password for the certificate into the **Password** field.
 6. Select **Create** to add the certificate to your API Management service.

articles/api-management/api-management-howto-deploy-multi-region.md

@@ -12,7 +12,7 @@ ms.service: api-management
 ms.workload: mobile
 ms.tgt_pltfrm: na
 ms.topic: article
-ms.date: 08/12/2019
+ms.date: 04/20/2020
 ms.author: apimpm
 ---
 
@@ -27,36 +27,23 @@ A new Azure API Management service initially contains only one [unit][unit] in a
 
 [!INCLUDE [premium.md](../../includes/api-management-availability-premium.md)]
 
-## <a name="add-region"> </a>Deploy an API Management service instance to a new region
+## <a name="add-region"> </a>Deploy API Management service to a new region
 
 > [!NOTE]
 > If you have not yet created an API Management service instance, see [Create an API Management service instance][create an api management service instance].
 
-In the Azure portal, navigate to the **Scale and pricing** page for your API Management service instance.
+1. In the Azure portal, navigate to your API Management service and click on the **Locations** entry in the menu.
+2. Click **+ Add** in the top bar.
+3. Select the location from the drop-down list and set the number of units with the slider.
+4. Click the **Add** button to confirm.
+5. Repeat this process until you configure all locations.
+6. Click **Save** in the top bar to start the deployment process.
 
-![Scale tab][api-management-scale-service]
+## <a name="remove-region"> </a>Delete an API Management service location
 
-To deploy to a new region, click on **+ Add region** from the toolbar.
-
-![Add region][api-management-add-region]
-
-Select the location from the drop-down list and set the number of units for with the slider.
-
-![Specify units][api-management-select-location-units]
-
-Click **Add** to place your selection in the Locations table.
-
-Repeat this process until you have all locations configured and click **Save** from the toolbar to start the deployment process.
-
-## <a name="remove-region"> </a>Delete an API Management service instance from a location
-
-In the Azure portal, navigate to the **Scale and pricing** page for your API Management service instance.
-
-![Scale tab][api-management-scale-service]
-
-For the location you would like to remove, open the context menu using the **...** button at the right end of the table. Select the **Delete** option.
-
-Confirm the deletion and click **Save** to apply the changes.
+1. In the Azure portal, navigate to your API Management service and click on the **Locations** entry in the menu.
+2. For the location you would like to remove, open the context menu using the **...** button at the right end of the table. Select the **Delete** option.
+3. Confirm the deletion and click **Save** to apply the changes.
 
 ## <a name="route-backend"> </a>Route API calls to regional backend services
 
@@ -115,11 +102,6 @@ API Management routes the requests to a regional _gateway_ based on [the lowest
 1. [Configure the API Management regional status endpoints in Traffic Manager](../traffic-manager/traffic-manager-monitoring.md). The regional status endpoints follow the URL pattern of `https://<service-name>-<region>-01.regional.azure-api.net/status-0123456789abcdef`, for example `https://contoso-westus2-01.regional.azure-api.net/status-0123456789abcdef`.
 1. Specify [the routing method](../traffic-manager/traffic-manager-routing-methods.md) of the Traffic Manager.
 
-[api-management-management-console]: ./media/api-management-howto-deploy-multi-region/api-management-management-console.png
-[api-management-scale-service]: ./media/api-management-howto-deploy-multi-region/api-management-scale-service.png
-[api-management-add-region]: ./media/api-management-howto-deploy-multi-region/api-management-add-region.png
-[api-management-select-location-units]: ./media/api-management-howto-deploy-multi-region/api-management-select-location-units.png
-[api-management-remove-region]: ./media/api-management-howto-deploy-multi-region/api-management-remove-region.png
 [create an api management service instance]: get-started-create-service-instance.md
 [get started with azure api management]: get-started-create-service-instance.md
 [deploy an api management service instance to a new region]: #add-region