Skip to content

Commit 1d3e399

Browse files
authored
Merge pull request #294136 from MicrosoftDocs/main
2/5/2025 AM Publish
2 parents d57b008 + 8788605 commit 1d3e399

File tree

109 files changed

+823
-552
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+823
-552
lines changed

articles/api-management/api-management-configuration-repository-git.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ ms.author: danlep
1313

1414
[!INCLUDE [premium-dev-standard-basic.md](../../includes/api-management-availability-premium-dev-standard-basic.md)]
1515

16+
> [!IMPORTANT]
17+
> Starting March 15, 2025, Azure API Management will [retire](breaking-changes/git-configuration-retirement-march-2025.md) the ability to manage the configuration of your service instance using the built-in Git repository. If you plan to continue using a Git repository to manage the configuration of your service instance after the retirement date, update your configuration management to use a different solution such as APIOps and your own Git repository implementation.
18+
1619
Each API Management service instance maintains a configuration database that contains information about the configuration and metadata for the service instance. Changes can be made to the service instance by changing a setting in the Azure portal, using Azure tools such as Azure PowerShell or the Azure CLI, or making a REST API call. In addition to these methods, you can manage your service instance configuration using Git, enabling scenarios such as:
1720

1821
* **Configuration versioning** - Download and store different versions of your service configuration
@@ -42,7 +45,7 @@ This article describes how to enable and use Git to manage your service configur
4245

4346
1. Navigate to your API Management instance in the [Azure portal](https://portal.azure.com/).
4447

45-
1. In the left menu, under **Deployment and infrastructure**, select **Repository**.
48+
1. In the left menu, under **Deployment + infrastructure**, select **Repository**.
4649

4750
:::image type="content" source="media/api-management-configuration-repository-git/api-management-enable-git.png" alt-text="Screenshot showing how to access Git configuration for API Management.":::
4851

@@ -67,7 +70,10 @@ For information on saving the service configuration using the REST API, see [Ten
6770

6871
## Get access credentials
6972

70-
To clone a repository, in addition to the URL to your repository, your need a username and a password.
73+
To clone a repository, in addition to the URL to your repository, you need a username and a password.
74+
75+
> [!CAUTION]
76+
> Using username and password credentials with a Git repository can pose security risks. Store your password securely and rotate it regularly. Don't store your credentials in plain text in code or configuration files.
7177
7278
1. On the **Repository** page, select **Access credentials** near the top of the page.
7379

@@ -91,19 +97,19 @@ git clone https://{name}.scm.azure-api.net/
9197

9298
Provide the username and password when prompted.
9399

94-
If you receive any errors, try modifying your `git clone` command to include the user name and password, as shown in the following example.
100+
If you receive any errors, try modifying your `git clone` command to include the username, as shown in the following example. Provide the password when prompted.
95101

96102
```
97-
git clone https://username:password@{name}.scm.azure-api.net/
103+
git clone https://username@{name}.scm.azure-api.net/
98104
```
99105

100-
If this provides an error, try URL encoding the password portion of the command. One quick way to do this is to open Visual Studio, and issue the following command in the **Immediate Window**. To open the **Immediate Window**, open any solution or project in Visual Studio (or create a new empty console application), and choose **Windows**, **Immediate** from the **Debug** menu.
106+
If this provides an error, try URL encoding the password and pass it in the command. One quick way to do this is to open Visual Studio, and issue the following command in the **Immediate Window**. To open the **Immediate Window**, open any solution or project in Visual Studio (or create a new empty console application), and choose **Windows**, **Immediate** from the **Debug** menu.
101107

102108
```
103109
?System.Net.WebUtility.UrlEncode("password from the Azure portal")
104110
```
105111

106-
Use the encoded password along with your user name and repository location to construct the git command.
112+
Use the encoded password along with your username and repository location to construct the git command.
107113

108114
```
109115
git clone https://username:url encoded password@{name}.scm.azure-api.net/
@@ -205,7 +211,7 @@ These files can be created, deleted, edited, and managed on your local file syst
205211
> * [Subscriptions](/rest/api/apimanagement/current-ga/subscription)
206212
> * Named values
207213
> * Developer portal entities other than styles and templates
208-
> * Policy Fragments
214+
> * Policy fragments
209215
>
210216
211217
### Root api-management folder
@@ -305,7 +311,8 @@ The `templates` folder contains configuration for the [email templates](api-mana
305311
* `<template name>\configuration.json` - Configuration for the email template.
306312
* `<template name>\body.html` - Body of the email template.
307313

308-
## Next steps
314+
## Related content
315+
309316
For information on other ways to manage your service instance, see:
310317

311318
* [Azure PowerShell cmdlet reference](/powershell/module/az.apimanagement)

articles/api-management/authentication-authorization-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ While authorization is preferred, and OAuth 2.0 has become the dominant method o
149149
|---------|---------|---------|
150150
|[Managed identity authentication](authentication-managed-identity-policy.md) | Authenticate to backend API with a system-assigned or user-assigned [managed identity](api-management-howto-use-managed-service-identity.md). | Recommended for scoped access to a protected backend resource by obtaining a token from Microsoft Entra ID. |
151151
|[Certificate authentication](authentication-certificate-policy.md) | Authenticate to backend API using a client certificate. | Certificate may be stored in key vault. |
152-
|[Basic authentication](authentication-basic-policy.md) | Authenticate to backend API with username and password that are passed through an Authorization header. | Discouraged if better options are available. |
152+
|[Basic authentication](authentication-basic-policy.md) | Authenticate to backend API with username and password that are passed through an Authorization header. | Discouraged if more secure authentication options are available (for example, managed identity, certificates, credential manager). If chosen, use [named values](api-management-howto-properties.md) to provide credentials, with secrets protected in a key vault.
153153

154154
## Next steps
155155
* Learn more about [authentication and authorization](../active-directory/develop/authentication-vs-authorization.md) in the Microsoft identity platform.

articles/api-management/breaking-changes/git-configuration-retirement-march-2025.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: danlep
1313

1414
[!INCLUDE [api-management-availability-premium-dev-standard-basic](../../../includes/api-management-availability-premium-dev-standard-basic.md)]
1515

16-
Effective 15 March 2025, Azure API Management will retire the ability to manage the configuration of your service instance using the built-in Git repository. If you plan to continue using a Git repository to manage the configuration of your service instance after the retirement date, you must update your configuration management to use a different solution such as APIOps and your own Git repository implementation.
16+
Starting 15 March 2025, Azure API Management will retire the ability to manage the configuration of your service instance using the built-in Git repository. If you plan to continue using a Git repository to manage the configuration of your service instance after the retirement date, you must update your configuration management to use a different solution such as APIOps and your own Git repository implementation.
1717

1818
## Is my service affected by this?
1919

articles/api-management/developer-portal-basic-authentication.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ description: Learn how to set up user accounts with username and password authen
55

66
author: dlepow
77
ms.service: azure-api-management
8-
ms.topic: article
9-
ms.date: 08/30/2022
8+
ms.topic: how-to
9+
ms.date: 01/10/2025
1010
ms.author: danlep
1111
---
1212

@@ -18,6 +18,8 @@ In the developer portal for Azure API Management, the default authentication met
1818

1919
For an overview of options to secure the developer portal, see [Secure access to the API Management developer portal](secure-developer-portal-access.md).
2020

21+
> [!CAUTION]
22+
> While you can use basic authentication to secure users' access to the developer portal, we recommend configuring a more secure authentication method such as [Microsoft Entra ID](api-management-howto-aad.md) or [Azure AD B2C](api-management-howto-aad-b2c.md), if available.
2123
2224
## Prerequisites
2325

articles/api-management/developer-portal-wordpress-plugin.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66
ms.service: azure-api-management
77
ms.custom:
88
ms.topic: how-to
9-
ms.date: 07/18/2024
9+
ms.date: 01/10/2025
1010
ms.author: danlep
1111
---
1212

@@ -35,9 +35,12 @@ For this scenario, you create a managed WordPress site hosted on Azure App Servi
3535

3636
1. In the Azure portal, navigate to [https://portal.azure.com/#create/WordPress.WordPress](https://portal.azure.com/#create/WordPress.WordPress).
3737

38-
1. On the **Create WordPress on App Service** page, in the **Basics** tab, enter your project details.
38+
1. On the **Create WordPress on App Service** page, in the **Basics** tab, enter your project details, Web App details, and WordPress setup settings.
3939

40-
Record the WordPress admin username and password in a safe place. These credentials are required to sign into the WordPress admin site and install the plugin in a later step.
40+
Store the WordPress admin username and password in a safe place. These credentials are required to sign into the WordPress admin site and install the plugin in a later step.
41+
42+
> [!CAUTION]
43+
> Avoid using the default WordPress `admin` username, and create a strong password. [Learn more about WordPress password best practices](https://wordpress.org/documentation/article/password-best-practices/)
4144
4245
1. On the **Add-ins** tab:
4346

articles/api-management/secure-developer-portal-access.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn about options to secure access to the API Management develope
55
author: dlepow
66

77
ms.service: azure-api-management
8-
ms.topic: conceptual
8+
ms.topic: concept-article
99
ms.date: 09/12/2023
1010
ms.author: danlep
1111
---
@@ -36,6 +36,9 @@ API Management has a fully customizable, standalone, managed [developer portal](
3636

3737
* **Basic authentication** - A default option is to use the built-in developer portal [username and password](developer-portal-basic-authentication.md) provider, which allows developers to register directly in API Management and sign in using API Management user accounts. User sign up through this option is protected by a CAPTCHA service.
3838

39+
> [!CAUTION]
40+
> While you can use basic authentication to secure users' access to the developer portal, we recommend configuring a more secure authentication method such as [Microsoft Entra ID](api-management-howto-aad.md) or [Azure AD B2C](api-management-howto-aad-b2c.md).
41+
3942

4043
## Developer portal test console
4144
In addition to providing configuration for developer users to sign up for access and sign in, the developer portal includes a test console where the developers can send test requests through API Management to the backend APIs. This test facility also exists for contributing users of API Management who manage the service using the Azure portal.
@@ -111,6 +114,6 @@ Key configurations:
111114
Go a step further by delegating [user registration or product subscription](api-management-howto-setup-delegation.md) and extend the process with your own logic.
112115

113116

114-
## Next steps
117+
## Related content
115118
* Learn more about [authentication and authorization](../active-directory/develop/authentication-vs-authorization.md) in the Microsoft identity platform.
116119
* Learn how to [mitigate OWASP API security threats](mitigate-owasp-api-threats.md) using API Management.

articles/api-management/sql-data-source-policy.md

Lines changed: 4 additions & 4 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: article
9-
ms.date: 07/23/2024
9+
ms.date: 01/10/2025
1010
ms.author: danlep
1111
---
1212

@@ -77,7 +77,7 @@ The `sql-data-source` resolver policy configures a Transact-SQL (T-SQL) request
7777

7878
| Attribute | Description | Required | Default |
7979
| ----------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------- | ------- |
80-
| use-managed-identity | Boolean. Specifies whether to use the API Management instance's system-assigned [managed identity](api-management-howto-use-managed-service-identity.md) for connection to the Azure SQL database in place of a username and password in the connection string. Policy expressions are allowed. <br/><br/>The identity must be [configured](#configure-managed-identity-integration-with-azure-sql) to access the Azure SQL database. | No | `false` |
80+
| use-managed-identity | Boolean. Specifies whether to use the API Management instance's system-assigned [managed identity](api-management-howto-use-managed-service-identity.md) for connection to the Azure SQL database in place of a username and password in the connection string. Policy expressions are allowed. <br/><br/>The identity must be [configured](#configure-managed-identity-integration-with-azure-sql) to access the Azure SQL database. Microsoft recommends this option as the most secure authentication method. | No | `false` |
8181

8282
### request attribute
8383

@@ -128,7 +128,7 @@ The `sql-data-source` resolver policy configures a Transact-SQL (T-SQL) request
128128

129129
## Configure managed identity integration with Azure SQL
130130

131-
You can configure an API Management system-assigned managed identity for access to Azure SQL instead of configuring SQL authentication with username and password. For background, see [Configure and manage Microsoft Entra authentication with Azure SQL](/azure/azure-sql/database/authentication-aad-configure).
131+
We strongly recommend configuring an API Management system-assigned managed identity for access to Azure SQL instead of configuring SQL authentication with username and password. For background, see [Configure and manage Microsoft Entra authentication with Azure SQL](/azure/azure-sql/database/authentication-aad-configure).
132132

133133
### Prerequisites
134134

@@ -149,7 +149,7 @@ Enable Microsoft Entra authentication to SQL Database by assigning a Microsoft E
149149

150150
1. In the portal, go to your Azure SQL database resource.
151151
1. Select **Query editor (preview)**.
152-
1. Login using Active Directory authentication.
152+
1. Login using Microsoft Entra authentication.
153153
1. Execute the following SQL script. Replace `<identity-name>` with the name of your API Management instance.
154154

155155
```sql

articles/automation/extension-based-hybrid-runbook-worker-install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: This article provides information about deploying the extension-bas
44
services: automation
55
ms.subservice: process-automation
66
ms.custom: devx-track-azurepowershell, devx-track-azurecli, devx-track-bicep, linux-related-content
7-
ms.date: 12/23/2024
7+
ms.date: 02/05/2025
88
ms.topic: how-to
99
#Customer intent: As a developer, I want to learn about extension so that I can efficiently deploy Hybrid Runbook Workers.
1010
ms.service: azure-automation
@@ -37,7 +37,7 @@ Azure Automation stores and manages runbooks and then delivers them to one or mo
3737

3838
| Windows (x64) | Linux (x64) |
3939
|---|---|
40-
| &#9679; Windows Server 2022 (including Server Core) <br> &#9679; Windows Server 2019 (including Server Core) <br> &#9679; Windows Server 2016, version 1709, and 1803 (excluding Server Core) <br> &#9679; Windows Server 2012, 2012 R2 (excluding Server Core) <br> &#9679; Windows 10 Enterprise (including multi-session) and Pro | &#9679; Debian GNU/Linux 8, 9, 10, 11, and 12 <br> &#9679; Ubuntu 18.04 LTS, 20.04 LTS, 22.04 LTS, and 24.04 LTS <br> &#9679; SUSE Linux Enterprise Server 15.2, 15.3, 15.4, 15.5, and 15.6 <br> &#9679; Red Hat Enterprise Linux Server 7, 8, and 9 <br> &#9679; Rocky Linux 9 </br> &#9679; Oracle Linux 7, 8, and 9 <br> *Hybrid Worker extension would follow support timelines of the OS vendor*.|
40+
| &#9679; Windows Server 2022 (including Server Core) <br> &#9679; Windows Server 2019 (including Server Core) <br> &#9679; Windows Server 2016, version 1709, and 1803 (excluding Server Core) <br> &#9679; Windows Server 2012, 2012 R2 (excluding Server Core) <br> &#9679; Windows 10 Enterprise (including multi-session) and Pro | &#9679; Debian GNU/Linux 8, 9, 10, and 11 <br> &#9679; Ubuntu 18.04 LTS, 20.04 LTS, and 22.04 LTS <br> &#9679; SUSE Linux Enterprise Server 15.2, 15.3, 15.4, 15.5, and 15.6 <br> &#9679; Red Hat Enterprise Linux Server 7, 8, and 9 <br> &#9679; Rocky Linux 9 </br> &#9679; Oracle Linux 7, 8, and 9 <br> *Hybrid Worker extension would follow support timelines of the OS vendor*.|
4141

4242

4343
### Other Requirements

articles/automation/migrate-existing-agent-based-hybrid-worker-to-extension-based-workers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Migrate an existing agent-based hybrid workers to extension-based-workers
33
description: This article provides information on how to migrate an existing agent-based hybrid worker to extension based workers.
44
services: automation
55
ms.subservice: process-automation
6-
ms.date: 01/02/2025
6+
ms.date: 02/05/2025
77
ms.custom: devx-track-azurecli, devx-track-bicep, devx-track-azurepowershell
88
ms.topic: how-to
99
#Customer intent: As a developer, I want to learn about extension so that I can efficiently migrate agent based hybrid workers to extension based workers.
@@ -55,7 +55,7 @@ The purpose of the Extension-based approach is to simplify the installation and
5555

5656
| Windows (x64) | Linux (x64) |
5757
|---|---|
58-
| &#9679; Windows Server 2022 (including Server Core) <br> &#9679; Windows Server 2019 (including Server Core) <br> &#9679; Windows Server 2016, version 1709, and 1803 (excluding Server Core) <br> &#9679; Windows Server 2012, 2012 R2 (excluding Server Core) <br> &#9679; Windows 10 Enterprise (including multi-session) and Pro | &#9679; Debian GNU/Linux 8, 9, 10, 11, and 12 <br> &#9679; Ubuntu 18.04 LTS, 20.04 LTS, 22.04 LTS, and 24.04 LTS <br> &#9679; SUSE Linux Enterprise Server 15.2, 15.3, 15.4, 15.5, and 15.6 <br> &#9679; Red Hat Enterprise Linux Server 7, 8, and 9 <br> &#9679; Rocky Linux 9 </br> &#9679; Oracle Linux 7, 8, and 9 <br> *Hybrid Worker extension would follow support timelines of the OS vendor*.|
58+
| &#9679; Windows Server 2022 (including Server Core) <br> &#9679; Windows Server 2019 (including Server Core) <br> &#9679; Windows Server 2016, version 1709, and 1803 (excluding Server Core) <br> &#9679; Windows Server 2012, 2012 R2 (excluding Server Core) <br> &#9679; Windows 10 Enterprise (including multi-session) and Pro | &#9679; Debian GNU/Linux 8, 9, 10, and 11 <br> &#9679; Ubuntu 18.04 LTS, 20.04 LTS, and 22.04 LTS <br> &#9679; SUSE Linux Enterprise Server 15.2, 15.3, 15.4, 15.5, and 15.6 <br> &#9679; Red Hat Enterprise Linux Server 7, 8, and 9 <br> &#9679; Rocky Linux 9 </br> &#9679; Oracle Linux 7, 8, and 9 <br> *Hybrid Worker extension would follow support timelines of the OS vendor*.|
5959

6060
### Other Requirements
6161

articles/automation/update-management/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ sudo yum -q --security check-update
174174
> [!NOTE]
175175
> Currently there's no supported method to enable native classification-data availability on CentOS. At this time, we provide limited support to customers who might have enabled this feature on their own.
176176
177-
**Redhat** - To classify updates on Red Hat Enterprise version 6, you must install the YUM security plugin. On Red Hat Enterprise Linux 7, the plugin is already a part of YUM itself and there's no need to install anything. For more information, see the following Red Hat [knowledge article](https://access.redhat.com/solutions/10021).
177+
**Red Hat** - To classify updates on Red Hat Enterprise version 6, you must install the YUM security plugin. On Red Hat Enterprise Linux 7, the plugin is already a part of YUM itself and there's no need to install anything. For more information, see the following Red Hat [knowledge article](https://access.redhat.com/solutions/10021).
178178

179179

180180
## Integrate Update Management with Configuration Manager

0 commit comments

Comments
 (0)