Skip to content

Commit 636795a

Browse files
author
gitName
committed
Merge branch 'main' of https://github.com/MicrosoftDocs/azure-docs-pr into appreg
2 parents 3a1c3df + 4b619f2 commit 636795a

File tree

582 files changed

+2124
-1374
lines changed

Some content is hidden

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

582 files changed

+2124
-1374
lines changed

articles/api-center/enable-managed-api-analysis-linting.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Managed API linting and analysis - Azure API Center
33
description: Automatic linting of API definitions in your API center helps you analyze compliance of APIs with the organization's API style guide.
44
ms.service: azure-api-center
55
ms.topic: how-to
6-
ms.date: 12/03/2024
6+
ms.date: 03/31/2025
77
ms.author: danlep
88
author: dlepow
99
ms.custom:
@@ -18,17 +18,15 @@ With API analysis:
1818

1919
* Azure API Center automatically analyzes your API definitions whenever you add or update an API definition. API definitions are linted by default with a [spectral:oas ruleset](https://docs.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules) (API style guide).
2020
* API analysis reports are generated in the Azure portal, showing how your API definitions conform to the style guide.
21-
* You can use the Azure API Center extension for Visual Studio Code to customize and test your own API style guide locally and then deploy it to your API center.
22-
21+
* Use analysis profiles to specify the ruleset and filter conditions for the APIs that are analyzed. Customize a profile's ruleset using the Azure API Center extension for Visual Studio Code.
2322

2423
> [!IMPORTANT]
2524
> If you prefer, you can enable [self-managed](enable-api-analysis-linting.md) linting and analysis using a custom Azure function, overriding the built-in capabilities. **Disable any function used for self-managed linting before using managed API analysis.**
2625
2726
## Limitations
2827

2928
* Currently, only OpenAPI and AsyncAPI specification documents in JSON or YAML format are analyzed.
30-
* Currently, you configure a single ruleset, and it's applied to all OpenAPI definitions in your API center.
31-
* There are [limits](../azure-resource-manager/management/azure-subscription-service-limits.md?toc=/azure/api-center/toc.json&bc=/azure/api-center/breadcrumb/toc.json#azure-api-center-limits) for the maximum number of API definitions analyzed. Analysis can take a few minutes to up to 24 hours to complete.
29+
* There are [limits](../azure-resource-manager/management/azure-subscription-service-limits.md?toc=/azure/api-center/toc.json&bc=/azure/api-center/breadcrumb/toc.json#azure-api-center-limits) for the number of analysis profiles and the maximum number of API definitions analyzed. Analysis can take a few minutes to up to 24 hours to complete.
3230

3331
## Prerequisites
3432

@@ -57,27 +55,50 @@ To view an analysis summary in your API center:
5755
> [!TIP]
5856
> You can also view the API analysis report by selecting **Analysis** from the API definition's menu bar.
5957
60-
## Customize ruleset
58+
## Manage analysis profiles
59+
60+
Azure API Center uses *analysis profiles* for linting and analyzing APIs. An analysis profile specifies a ruleset and optionally filter conditions for APIs that are analyzed. The default analysis profile applies the `spectral:oas` ruleset to all OpenAPI and AsyncAPI definitions.
61+
62+
You can customize the ruleset and define filter conditions in the default profile, or you can create a new profile. For example, you might want to use one profile for APIs that are in development and a different one for APIs that are in production.
63+
64+
> [!NOTE]
65+
> In the Standard plan of API Center, you can create up to 3 analysis profiles. Only a single profile is supported in the Free plan.
66+
67+
To create an analysis profile:
68+
69+
1. In the Azure portal, navigate to your API center.
70+
1. In the left-hand menu, under **Governance**, select **API Analysis** > **Manage analysis profiles** > **+ Create analysis profile**.
71+
1. In the **Create new analysis profile** pane, enter a **Name** and **Description** for the profile.
72+
1. In **Ruleset**, the analyzer type (linting engine) for the ruleset appears. Currently only Spectral is supported.
73+
1. Under **Define filter conditions**, add one or more filter conditions for API definitions that the profile is applied to.
74+
1. Select **Create**.
75+
76+
77+
:::image type="content" source="media/enable-managed-api-analysis-linting/create-analysis-profile.png" alt-text="Screenshot of creating an analysis profile in the portal.":::
78+
79+
The profile is created and a ruleset scaffold is created. To view the current ruleset, select the profile, and in the context (...) menu, select **View the ruleset**.
80+
81+
Continue to the following sections to customize the ruleset.
6182

62-
You can use the Azure API Center extension for Visual Studio Code to customize the default ruleset for your API center or replace it as your organization's API style guide. For example, you can [extend the ruleset](https://docs.stoplight.io/docs/spectral/83527ef2dd8c0-extending-rulesets) or add [custom functions](https://docs.stoplight.io/docs/spectral/a781e290eb9f9-custom-functions).
83+
### Customize the profile's ruleset
6384

64-
To customize or replace the ruleset:
85+
Use the Visual Studio Code extension for Azure API Center to customize a profile's ruleset. After customizing the ruleset and testing it locally, you can deploy it back to your API center.
6586

6687
1. In Visual Studio Code, select the Azure API Center icon from the Activity Bar.
67-
1. Open the `.api-center-rules` folder at the root of your working folder.
68-
1. In the folder for your API center resource, open the `ruleset.yml` file.
88+
1. In the API Center pane, expand the API center resource you are working with, and expand **Profiles**.
89+
1. Expand the profile you want to modify, and select `ruleset.yaml`.
6990
1. Modify or replace the content as needed.
70-
1. Save your changes to `ruleset.yml`.
91+
1. Save your changes to `ruleset.yaml`.
7192

7293
### Test ruleset locally
7394

7495
Before deploying the custom ruleset to your API center, validate it locally. The Azure API Center extension for Visual Studio Code provides integrated support for API specification linting with Spectral.
7596

7697
1. In Visual Studio Code, use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette.
7798
1. Type **Azure API Center: Set active API Style Guide** and hit **Enter**.
78-
1. Choose **Select Local File** and specify the `ruleset.yml` file that you customized. Hit **Enter**.
99+
1. Choose **Select Local File** and specify the `ruleset.yaml` file that you customized. Hit **Enter**.
79100

80-
This step makes the custom ruleset the active API style guide for linting.
101+
This step makes the custom ruleset the active API style guide for local linting.
81102

82103
Now, when you open an OpenAPI-based API definition file, a local linting operation is automatically triggered in Visual Studio Code. Results are displayed inline in the editor and in the **Problems** window (**View > Problems** or **Ctrl+Shift+M**).
83104

@@ -94,9 +115,10 @@ To deploy the custom ruleset to your API center:
94115

95116
1. In Visual Studio Code, select the Azure API Center icon from the Activity Bar.
96117
1. In the API Center pane, expand the API center resource in which you customized the ruleset.
97-
1. Right-click **Rules** and select **Deploy Rules to API Center**.
118+
1. Expand **Profiles**.
119+
1. Right-click the profile in which you customized the ruleset, and select **Deploy Rules to API Center**.
98120

99-
A message notifies you after the rules are successfully deployed to your API center. The linting engine uses the updated ruleset to analyze API definitions.
121+
A message notifies you after the rules are successfully deployed to your API center. The linting engine uses the updated ruleset to analyze API definitions in the profile.
100122

101123
To see the results of linting with the updated ruleset, view the API analysis reports in the portal.
102124

articles/api-center/includes/api-center-service-limits.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ ms.custom: Include file
2323
| Maximum number of child properties in custom metadata property of type "object" | 10 |10 |
2424
| Maximum requests per minute (data plane) | 3,000 | 6,000 |
2525
| Maximum number of API definitions [analyzed](../enable-managed-api-analysis-linting.md) | 10 | 2,000<sup>4</sup> |
26+
| Maximum number of analysis profiles | 1 | 3 |
2627
| Maximum number of linked API sources<sup>5</sup> | 1 | 3 |
2728
| Maximum number of APIs synchronized from a linked API source | 200 | 2,000<sup>4</sup> |
2829

4.93 KB
Loading
123 KB
Loading

articles/app-service/configure-custom-container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ For more troubleshooting information, see the Azure App Service blog: [Enabling
489489
## Configure multi-container apps
490490

491491
> [!NOTE]
492-
> Sidecar containers succeed multi-container apps in App Service. To get started, see [Tutorial: Configure a sidecar container for custom container in Azure App Service](tutorial-custom-container-sidecar.md).
492+
> The Docker Compose feature will be retired on March 31, 2027. Sidecar containers succeed multi-container apps in App Service. For new services, refer to [Tutorial: Configure a sidecar container for custom container in Azure App Service](tutorial-custom-container-sidecar.md). For existing multi-container apps in App Service, refer to [Migrating your Docker Compose applications to the Sidecar feature](https://azure.github.io/AppService/2025/04/01/Docker-compose-migration.html).
493493
494494
- [Use persistent storage in Docker Compose](#use-persistent-storage-in-docker-compose)
495495
- [Preview limitations](#preview-limitations)

0 commit comments

Comments
 (0)