Skip to content

Commit 401a1c0

Browse files
committed
Merge branch 'main' of https://github.com/MicrosoftDocs/azure-docs-pr into waf-policy
2 parents 7b07be8 + 114924d commit 401a1c0

124 files changed

Lines changed: 2825 additions & 1029 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
title: Govern APIs - VS Code extension
2+
title: Govern APIs - Visual Studio Code Extension
33
description: API developers can use the Azure API Center extension for Visual Studio Code to govern their organization's APIs.
44

55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 10/16/2024
8-
7+
ms.date: 02/19/2026
98
ms.custom:
109
- sfi-image-nochange
1110
# Customer intent: As an API developer, I want to use my Visual Studio Code environment to check API compliance in my organization's API center.
@@ -18,45 +17,47 @@ To maximize success of your API governance efforts, it's critical to shift-left
1817
The Azure API Center extension for Visual Studio Code includes the following governance capabilities for API developers:
1918

2019
* Evaluating API designs against API style guides as the API is developed in Visual Studio Code.
21-
* Early detection of breaking changes so that APIs remain reliable and function as expected, preserving the trust of end-users and stakeholders.
20+
* Early detection of breaking changes so APIs remain reliable and function as expected, preserving the trust of end-users and stakeholders.
2221

2322
API developers can also take advantage of features in the extension to [register APIs](build-register-apis-vscode-extension.md) in the API center and [discover and consume APIs](discover-apis-vscode-extension.md).
2423

2524
[!INCLUDE [vscode-extension-basic-prerequisites](includes/vscode-extension-basic-prerequisites.md)]
2625

27-
* [Spectral extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral) - to run shift-left API design conformance checks in Visual Studio Code
28-
* [Optic CLI](https://github.com/opticdev/optic) - to detect breaking changes between API specification documents
26+
* [Spectral extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral) to run shift-left API design conformance checks in Visual Studio Code.
27+
28+
* [Optic CLI](https://github.com/opticdev/optic) to detect breaking changes between API specification documents.
2929

3030
[!INCLUDE [vscode-extension-setup](includes/vscode-extension-setup.md)]
3131

3232
## API design conformance
3333

3434
To ensure design conformance with organizational standards as you build APIs, the Azure API Center extension for Visual Studio Code provides integrated support for API specification linting with [Spectral](https://stoplight.io/open-source/spectral).
3535

36-
1. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Set active API Style Guide** and hit **Enter**.
37-
2. Select one of the default rules provided, or, if your organization has a style guide already available, use **Select Local File** or **Input Remote URL** to specify the active ruleset in Visual Studio Code. Hit **Enter**.
36+
1. Use the **Ctrl**+**Shift**+**P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Set active API Style Guide** followed by the **Enter** key.
3837

39-
Once an active API style guide is set, opening any OpenAPI or AsyncAPI-based specification file triggers a local linting operation in Visual Studio Code. Results are displayed both inline in the editor and in the Problems window (**View** > **Problems** or **Ctrl+Shift+M**).
38+
1. Select one of the default rules provided. If your organization has a style guide already available, select the **Select Local File** or **Input Remote URL** option and specify the active ruleset in Visual Studio Code. Select **Enter**.
39+
40+
After an active API style guide is set, opening any OpenAPI or AsyncAPI-based specification file triggers a local linting operation in Visual Studio Code. Results are displayed both inline in the editor and in the **Problems** window (**View** > **Problems** or **Ctrl**+**Shift**+**M**).
4041

4142
:::image type="content" source="media/govern-apis-vscode-extension/local-linting.png" alt-text="Screenshot of local-linting in Visual Studio Code." lightbox="media/govern-apis-vscode-extension/local-linting.png":::
4243

4344
## Breaking change detection
4445

45-
When introducing new versions of your API, it's important to ensure that changes introduced do not break API consumers on previous versions of your API. The Azure API Center extension for Visual Studio Code makes this easy with breaking change detection for OpenAPI specification documents powered by [Optic](https://github.com/opticdev/optic).
46+
When introducing new versions of your API, it's important to ensure that changes introduced don't break API consumers on previous versions of your API. The Azure API Center extension for Visual Studio Code makes this task easy with breaking change detection for OpenAPI specification documents powered by [Optic](https://github.com/opticdev/optic).
4647

47-
1. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Detect Breaking Change** and hit **Enter**.
48-
2. Select the first API specification document to compare. Valid options include API specifications found in your API center, a local file, or the active editor in Visual Studio Code.
49-
3. Select the second API specification document to compare. Valid options include API specifications found in your API center, a local file, or the active editor in Visual Studio Code.
48+
1. Use the **Ctrl**+**Shift**+**P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Detect Breaking Change** followed by the **Enter** key.
5049

51-
Visual Studio Code opens a diff view between the two API specifications. Any breaking changes are displayed both inline in the editor and in the Problems window (**View** > **Problems** or **Ctrl+Shift+M**).
50+
1. Select the first API specification document to compare. Valid options include API specifications found in your API center, a local file, or the active editor in Visual Studio Code.
5251

53-
:::image type="content" source="media/govern-apis-vscode-extension/breaking-changes.png" alt-text="Screenshot of breaking changes detected in Visual Studio Code." lightbox="media/govern-apis-vscode-extension/breaking-changes.png":::
52+
1. Select the second API specification document to compare. Valid options include API specifications found in your API center, a local file, or the active editor in Visual Studio Code.
5453

54+
Visual Studio Code opens a diff view between the two API specifications. Any breaking changes are displayed both inline in the editor and in the **Problems** window (**View** > **Problems** or **Ctrl**+**Shift**+**M**).
55+
56+
:::image type="content" source="media/govern-apis-vscode-extension/breaking-changes.png" alt-text="Screenshot of breaking changes detected in Visual Studio Code." lightbox="media/govern-apis-vscode-extension/breaking-changes.png":::
5557

5658
## Related content
5759

5860
* [Azure API Center - key concepts](key-concepts.md)
5961
* [Build and register APIs with the Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md)
6062
* [Discover and consume APIs with the Azure API Center extension for Visual Studio Code](discover-apis-vscode-extension.md)
61-
* [Enable and view API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)
62-
63+
* [Enable and view the API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)

articles/api-center/includes/vscode-extension-basic-prerequisites.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Include file
3-
description: Include file
3+
description: Basic prerequisites for using the Azure API Center extension for Visual Studio Code.
44
services: api-center
55

66

@@ -17,6 +17,6 @@ ms.custom: Include file
1717

1818
* [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center)
1919

20-
* One or more API centers in your Azure subscription. You can [create an API center using the Azure API Center extension](../set-up-api-center-vs-code-extension.md) or other tools.
20+
* One or more API centers in your Azure subscription. You can [create an API center by using the Azure API Center extension](../set-up-api-center-vs-code-extension.md) or other tools.
2121

22-
* Currently, you need to be assigned the Azure API Center Service Contributor role or higher permissions on an API center to manage APIs with the extension.
22+
* To manage APIs with the extension, you currently need the Azure API Center Service Contributor role or higher permissions on an API center.
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
---
22
title: Include file
3-
description: Include file
3+
description: Describes how to install and select specific versions of the Azure API Center extension in Visual Studio Code.
44
services: api-center
55

66

77
ms.service: azure-api-center
88
ms.topic: include
9-
ms.date: 09/23/2024
10-
9+
ms.date: 02/19/2026
1110
ms.custom: Include file
1211
---
1312

14-
When installing the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center&ssr=false#overview), you can choose to install the release version or a pre-release version. Switch between the two versions at any time by using the extension's **Manage** button context menu in the Extensions view.
13+
When you install the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center&ssr=false#overview), you can choose to install the release version or a prerelease version (as available). To switch between installed versions, select the extension's **Manage** button (gear icon) in the **Extensions** view in Visual Studio Code.
Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
11
---
22
title: Include file
3-
description: Include file
3+
description: The setup procedure for the Azure API Center extension for Visual Studio Code.
44
services: api-center
55

66

77
ms.service: azure-api-center
88
ms.topic: include
9-
ms.date: 06/24/2025
10-
9+
ms.date: 02/19/2026
1110
ms.custom: Include file
1211
---
1312

1413
## Extension setup
1514

15+
Set up the extension by following these steps:
16+
1617
1. Install the Azure API Center extension for Visual Studio Code from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center). Install other extensions as needed.
1718

18-
> [!NOTE]
19-
> Where noted, certain features are available only in the Azure API Center extension's pre-release version. [!INCLUDE [vscode-extension-prerelease-features](vscode-extension-prerelease-features.md)]
20-
1. In Visual Studio Code, in the Activity Bar on the left, select API Center.
19+
> [!NOTE]
20+
> The `[PREVIEW]` notation indicates features available only in the prerelease version of the Azure API Center extension. [!INCLUDE [vscode-extension-prerelease-features](vscode-extension-prerelease-features.md)]
21+
22+
1. In Visual Studio Code, in the Activity bar, select API Center:
23+
24+
:::image type="content" source="media/vscode-extension-setup/api-center-activity-bar.png" border="false" alt-text="Screenshot of API Center extension icon in the Visual Studio Code Activity bar.":::
25+
26+
1. If you're not signed in to your Azure account, select **Sign in to Azure**, and follow the prompts to sign in.
2127

22-
:::image type="content" source="media/vscode-extension-setup/api-center-activity-bar.png" alt-text="Screenshot of API Center extension in the activity bar.":::
23-
1. If you're not signed in to your Azure account, select **Sign in to Azure...**, and follow the prompts to sign in.
24-
Select an Azure subscription with the API center (or API centers) you wish to view APIs from. You can also filter on specific subscriptions if you have many to view from.
28+
1. Select an Azure subscription with the API center (or API centers) that has the APIs you want to view. If you have multiple accounts, you can filter on specific subscriptions.

articles/api-management/TOC.yml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -403,12 +403,20 @@
403403
href: how-to-configure-local-metrics-logs.md
404404
- name: Enable Dapr support on self-hosted gateway
405405
href: self-hosted-gateway-enable-dapr.md
406-
- name: Use Microsoft Entra authentication on self-hosted gateway
407-
href: self-hosted-gateway-enable-azure-ad.md
408-
- name: Run self-hosted gateway in production
409-
href: how-to-self-hosted-gateway-on-kubernetes-in-production.md
410-
- name: Self-hosted gateway support policy
411-
href: self-hosted-gateway-support-policies.md
406+
- name: Configure authentication to cloud instance
407+
items:
408+
- name: Self-hosted gateway authentication options
409+
href: self-hosted-gateway-authentication-options.md
410+
- name: Authenticate with Microsoft Entra ID - workload identity
411+
href: self-hosted-gateway-enable-workload-identity.md
412+
- name: Authenticate with Microsoft Entra ID - client secret
413+
href: self-hosted-gateway-enable-azure-ad.md
414+
- name: Authenticate with an access token
415+
href: self-hosted-gateway-default-authentication.md
416+
- name: Run self-hosted gateway in production
417+
href: how-to-self-hosted-gateway-on-kubernetes-in-production.md
418+
- name: Self-hosted gateway support policy
419+
href: self-hosted-gateway-support-policies.md
412420
- name: Developer portal and publishing
413421
items:
414422
- name: Manage users, groups, and subscriptions

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ In this article you:
3737
3838

3939
> [!NOTE]
40-
> Internal caching isn't available in the **Consumption** tier of Azure API Management. You can [use an external Azure Cache for Redis](api-management-howto-cache-external.md) instead. You can also configure an external cache in other API Management service tiers.
40+
> Internal caching isn't available in the **Consumption** tier of Azure API Management. You can [use an external Redis-compatible cache](api-management-howto-cache-external.md) instead. You can also configure an external cache in other API Management service tiers.
4141
>
4242
4343
## Prerequisites

articles/api-management/cache-lookup-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Use the `cache-lookup` policy to perform cache lookup and return a valid cached
4747
| Attribute | Description | Required | Default |
4848
| ----------------- | ------------------------------------------------------ | -------- | ------- |
4949
| allow-private-response-caching | When set to `true`, allows caching of requests that contain an Authorization header. Policy expressions are allowed. | No | `false` |
50-
| caching-type | Choose between the following values of the attribute:<br />- `internal` to use the [built-in API Management cache](api-management-howto-cache.md),<br />- `external` to use the external cache as described in [Use an external Azure Cache for Redis in Azure API Management](api-management-howto-cache-external.md),<br />- `prefer-external` to use external cache if configured or internal cache otherwise.<br/><br/>Policy expressions aren't allowed. | No | `prefer-external` |
50+
| caching-type | Choose between the following values of the attribute:<br />- `internal` to use the [built-in API Management cache](api-management-howto-cache.md),<br />- `external` to use the external cache as described in [Use an external Redis-compatible cache in Azure API Management](api-management-howto-cache-external.md),<br />- `prefer-external` to use external cache if configured or internal cache otherwise.<br/><br/>Policy expressions aren't allowed. | No | `prefer-external` |
5151
| downstream-caching-type | This attribute must be set to one of the following values.<br /><br /> - none - downstream caching is not allowed.<br />- private - downstream private caching is allowed.<br />- public - private and shared downstream caching is allowed.<br/><br/>Policy expressions are allowed. | No | none |
5252
| must-revalidate | When downstream caching is enabled this attribute turns on or off the `must-revalidate` cache control directive in gateway responses. Policy expressions are allowed. | No | `true` |
5353
| vary-by-developer | Set to `true` to cache responses per developer account that owns [subscription key](./api-management-subscriptions.md) included in the request. Policy expressions are allowed. | Yes | `false` |

articles/api-management/cache-lookup-value-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Use the `cache-lookup-value` policy to perform cache lookup by key and return a
3737

3838
| Attribute | Description | Required | Default |
3939
|---|--|--|--|
40-
| caching-type | Choose between the following values of the attribute:<br />- `internal` to use the [built-in API Management cache](api-management-howto-cache.md),<br />- `external` to use the external cache as described in [Use an external Azure Cache for Redis in Azure API Management](api-management-howto-cache-external.md),<br />- `prefer-external` to use external cache if configured or internal cache otherwise.<br/><br/>Policy expressions aren't allowed. | No | `prefer-external` |
40+
| caching-type | Choose between the following values of the attribute:<br />- `internal` to use the [built-in API Management cache](api-management-howto-cache.md),<br />- `external` to use the external cache as described in [Use an external Redis-compatible cache in Azure API Management](api-management-howto-cache-external.md),<br />- `prefer-external` to use external cache if configured or internal cache otherwise.<br/><br/>Policy expressions aren't allowed. | No | `prefer-external` |
4141
| default-value | A value that will be assigned to the variable if the cache key lookup resulted in a miss. If this attribute is not specified, `null` is assigned. Policy expressions are allowed. | No | `null` |
4242
| key | Cache key value to use in the lookup. Policy expressions are allowed. | Yes | N/A |
4343
| variable-name | Name of the [context variable](api-management-policy-expressions.md#ContextVariables) the looked up value will be assigned to, if lookup is successful. If lookup results in a miss, the variable will not be set. Policy expressions aren't allowed. | Yes | N/A |

0 commit comments

Comments
 (0)