Skip to content

Commit 3da3d53

Browse files
authored
Merge pull request #100541 from vladvino/jedi
Added notes on using AKV for certs and NVs
2 parents 595ed77 + 16103e9 commit 3da3d53

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

articles/api-management/api-management-howto-mutual-certificates.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.service: api-management
1212
ms.workload: mobile
1313
ms.tgt_pltfrm: na
1414
ms.topic: article
15-
ms.date: 06/20/2018
15+
ms.date: 01/08/2020
1616
ms.author: apimpm
1717
---
1818

@@ -26,19 +26,22 @@ For information about managing certificates using the API Management REST API, s
2626

2727
[!INCLUDE [updated-for-az](../../includes/updated-for-az.md)]
2828

29-
This guide shows you how to configure your API Management service instance to use client certificate authentication to access the back-end service for an API. Before following the steps in this article, you should have your back-end service configured for client certificate authentication ([to configure certificate authentication in Azure WebSites refer to this article][to configure certificate authentication in Azure WebSites refer to this article]). You need access to the certificate and the password for uploading it to the API Management service.
29+
This guide shows you how to configure your API Management service instance to use client certificate authentication to access the back-end service for an API. Before following the steps in this article, you should have your back-end service configured for client certificate authentication ([to configure certificate authentication in the Azure App Service refer to this article][to configure certificate authentication in Azure WebSites refer to this article]). You need access to the certificate and the password for uploading it to the API Management service.
3030

3131
## <a name="step1"> </a>Upload a Certificate
3232

33+
> [!NOTE]
34+
> Instead of an uploaded certificate you can use a certificate stored in the [Azure Key Vault](https://azure.microsoft.com/services/key-vault/) service as shown in this [example](https://github.com/galiniliev/api-management-policy-snippets/blob/galin/AkvCert/examples/Look%20up%20Key%20Vault%20certificate%20using%20Managed%20Service%20Identity%20and%20call%20backend.policy.xml).
35+
3336
![Add client certificates](media/api-management-howto-mutual-certificates/apim-client-cert-new.png)
3437

3538
Follow the steps below to upload a new client certificate. If you have not created an API Management service instance yet, see the tutorial [Create an API Management service instance][Create an API Management service instance].
3639

3740
1. Navigate to your Azure API Management service instance in the Azure portal.
3841
2. Select **Certificates** from the menu.
39-
3. Click the **+ Add** button.
40-
![Add client certificates](media/api-management-howto-mutual-certificates/apim-client-cert-add.png)
41-
4. Browse for the certificate, provide its ID and password.
42+
3. Click the **+ Add** button.
43+
![Add client certificates](media/api-management-howto-mutual-certificates/apim-client-cert-add.png)
44+
4. Browse for the certificate, provide its ID and password.
4245
5. Click **Create**.
4346

4447
> [!NOTE]
@@ -61,14 +64,14 @@ If the certificate is in use by an API, then a warning screen is displayed. To d
6164

6265
## <a name="step2"> </a>Configure an API to use a client certificate for gateway authentication
6366

64-
1. Click **APIs** from the **API Management** menu on the left and navigate to the API.
67+
1. Click **APIs** from the **API Management** menu on the left and navigate to the API.
6568
![Enable client certificates](media/api-management-howto-mutual-certificates/apim-client-cert-enable.png)
6669

67-
2. In the **Design** tab, click on a pencil icon of the **Backend** section.
68-
3. Change the **Gateway credentials** to **Client cert** and select your certificate from the dropdown.
70+
2. In the **Design** tab, click on a pencil icon of the **Backend** section.
71+
3. Change the **Gateway credentials** to **Client cert** and select your certificate from the dropdown.
6972
![Enable client certificates](media/api-management-howto-mutual-certificates/apim-client-cert-enable-select.png)
7073

71-
4. Click **Save**.
74+
4. Click **Save**.
7275

7376
> [!WARNING]
7477
> This change is effective immediately, and calls to operations of that API will use the certificate to authenticate on the back-end server.

articles/api-management/api-management-howto-properties.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ ms.service: api-management
1111
ms.workload: mobile
1212
ms.tgt_pltfrm: na
1313
ms.topic: article
14-
ms.date: 11/05/2019
14+
ms.date: 01/08/2020
1515
ms.author: apimpm
1616
---
1717

1818
# How to use named values in Azure API Management policies
1919

2020
API Management policies are a powerful capability of the system that allow the Azure portal to change the behavior of the API through configuration. Policies are a collection of statements that are executed sequentially on the request or response of an API. Policy statements can be constructed using literal text values, policy expressions, and named values.
2121

22-
Each API Management service instance has a properties collection of key/value pairs, which is called named values, that are global to the service instance. There is no imposed limit on the number of items in the collection. Named values can be used to manage constant string values across all API configuration and policies. Each named value may have the following attributes:
22+
Each API Management service instance has a collection of key/value pairs, which is called named values, that are global to the service instance. There is no imposed limit on the number of items in the collection. Named values can be used to manage constant string values across all API configuration and policies. Each named value may have the following attributes:
2323

24-
| Attribute | Type | Description |
25-
| -------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
24+
| Attribute | Type | Description |
25+
| -------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
2626
| `Display name` | string | Used for referencing the named value in policies. A string of one to 256 characters. Only letters, numbers, dot, and dash are allowed. |
27-
| `Value` | string | Actual value. Must not be empty or consist only of whitespace. Maximum of 4096 characters long. |
28-
| `Secret` | boolean | Determines whether the value is a secret and should be encrypted or not. |
27+
| `Value` | string | Actual value. Must not be empty or consist only of whitespace. Maximum of 4096 characters long. |
28+
| `Secret` | boolean | Determines whether the value is a secret and should be encrypted or not. |
2929
| `Tags` | array of string | Used to filter the named value list. Up to 32 tags. |
3030

3131
![Named values](./media/api-management-howto-properties/named-values.png)
@@ -38,6 +38,9 @@ Named values can contain literal strings and [policy expressions](/azure/api-man
3838
| Credential | •••••••••••••••••••••• | True | security |
3939
| Expression | @(DateTime.Now.ToString()) | False | |
4040

41+
> [!NOTE]
42+
> Instead of named values stored within an API Management service, you can use values stored in the [Azure Key Vault](https://azure.microsoft.com/services/key-vault/) service as demonstrated by this [example](https://github.com/Azure/api-management-policy-snippets/blob/master/examples/Look%20up%20Key%20Vault%20secret%20using%20Managed%20Service%20Identity.policy.xml).
43+
4144
## To add and edit a named value
4245

4346
![Add a named value](./media/api-management-howto-properties/add-property.png)
@@ -46,7 +49,7 @@ Named values can contain literal strings and [policy expressions](/azure/api-man
4649
2. Select **Named values**.
4750
3. Press **+Add**.
4851

49-
Name and Value are required values. If value is a secret, check the *This is a secret* checkbox. Enter one or more optional tags to help with organizing your named values, and click Save.
52+
Name and Value are required values. If value is a secret, check the _This is a secret_ checkbox. Enter one or more optional tags to help with organizing your named values, and click Save.
5053

5154
4. Click **Create**.
5255

0 commit comments

Comments
 (0)