You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-center/build-register-apis-vscode-extension.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: API developers can use the Azure API Center extension for Visual St
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: how-to
7
-
ms.date: 11/08/2024
7
+
ms.date: 05/28/2025
8
8
ms.author: danlep
9
9
ms.collection: ce-skilling-ai-copilot
10
10
ms.custom:
@@ -60,6 +60,8 @@ Use the power of [GitHub Copilot](https://marketplace.visualstudio.com/items?ite
60
60
61
61
:::image type="content" source="media/build-register-apis-vscode-extension/generate-api-documentation.gif" alt-text="Animation showing how to use GitHub Copilot to generate an OpenAPI spec from code." lightbox="media/build-register-apis-vscode-extension/generate-api-documentation.gif":::
62
62
63
+
You can also generate an OpenAPI specification from all of the files in your current project. Use the **Azure API Center: Generate OpenAPI Spec from Entire Project** command from the Command Palette.
64
+
63
65
After generating the OpenAPI specification file and checking for accuracy, you can register the API with your API center using the **Azure API Center: Register API** command.
64
66
65
67
> [!TIP]
@@ -70,6 +72,6 @@ After generating the OpenAPI specification file and checking for accuracy, you c
70
72
*[Azure API Center - key concepts](key-concepts.md)
71
73
*[Discover and consume APIs with the Azure API Center extension for Visual Studio Code](discover-apis-vscode-extension.md)
72
74
*[Govern APIs with the Azure API Center extension for Visual Studio Code](govern-apis-vscode-extension.md)
73
-
*[Enable and view API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)
75
+
*[Enable API Center portal view in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)
74
76
*[Overview of GitHub Copilot for Azure](/azure/developer/github-copilot-azure/introduction)
Copy file name to clipboardExpand all lines: articles/api-center/discover-apis-vscode-extension.md
+21-6Lines changed: 21 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: API developers can use the Azure API Center extension for Visual St
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: how-to
7
-
ms.date: 10/16/2024
7
+
ms.date: 05/27/2025
8
8
ms.author: danlep
9
9
ms.custom:
10
10
# Customer intent: As an API developer, I want to use my Visual Studio Code environment to discover and consume APIs in my organizations API center.
@@ -21,12 +21,13 @@ API developers in your organization can discover and consume APIs in your [API c
21
21
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 ensure [API governance](govern-apis-vscode-extension.md).
22
22
23
23
> [!TIP]
24
-
> If you want enterprise app developers to discover your APIs in a centralized location, optionally enable the read-only [API Center portal](enable-api-center-portal-vs-code-extension.md) in Visual Studio Code.
24
+
> If you want enterprise app developers to discover your APIs in a centralized location, optionally enable the read-only [API Center portal view](enable-api-center-portal-vs-code-extension.md) in Visual Studio Code.
*[REST client extension](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) - to send HTTP requests and view the responses in Visual Studio Code directly
29
29
*[Microsoft Kiota extension](https://marketplace.visualstudio.com/items?itemName=ms-graph.kiota) - to generate API clients
30
+
-[Microsoft 365 Agents Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) - to create Microsoft 365 declarative agents
@@ -36,7 +37,7 @@ API center resources appear in the tree view on the left-hand side. Expand an AP
36
37
37
38
:::image type="content" source="media/discover-apis-vscode-extension/explore-api-centers.png" alt-text="Screenshot of API Center tree view in Visual Studio Code." lightbox="media/discover-apis-vscode-extension/explore-api-centers.png":::
38
39
39
-
Search for APIs within an API Center by using the search icon shown in the **Apis** tree view item.
40
+
Search for APIs within an API Center by using the search icon shown in the **APIs** tree view item.
40
41
41
42
## View API documentation
42
43
@@ -53,7 +54,7 @@ You can view the documentation for an API definition in your API center and try
53
54
> Depending on the API, you might need to provide authorization credentials or an API key to try the API.
54
55
55
56
> [!TIP]
56
-
> Using the pre-release version of the extension, you can generate API documentation in Markdown, a format that's easy to maintain and share with end users. Right-click on the definition, and select **Generate Markdown**.
57
+
> You can generate API documentation in Markdown, a format that's easy to maintain and share with end users. Right-click on the definition, and select **Generate Markdown**.
57
58
58
59
## Generate HTTP file
59
60
@@ -103,10 +104,24 @@ You can also export a specification using the Command Palette:
103
104
1. Select **Azure API Center: Export API Specification Document**.
104
105
1. Make selections to navigate to an API definition. A new tab appears that renders an API specification document.
105
106
106
-
## Related content
107
+
108
+
## Create M365 declarative agent
109
+
110
+
You can create a [declarative agent for Microsoft 365 Copilot](/microsoft-365-copilot/extensibility/overview-declarative-agent) from an OpenAPI definition in your API center. With a declarative agent, you customize Microsoft 365 Copilot to help you meet the unique business needs of your users. When you build a declarative agent, you provide the instructions, actions, and knowledge to tailor Copilot for your business scenarios.
111
+
112
+
To export a declarative agent in the extension's tree view:
113
+
114
+
1. Expand the API Center tree view to show an OpenAPI definition.
115
+
1. Right-click on the definition, and select **Export M365 Declarative Agent**.
116
+
1. When prompted:
117
+
1. Select one or more API operations that Copilot can interact with.
118
+
1. Select a workspace folder.
119
+
1. Enter an application name.
120
+
121
+
The declarative agent is created in the selected workspace folder. Use the Microsoft 365 Agents Toolkit to further customize and deploy the agent.
107
122
108
123
*[Azure API Center - key concepts](key-concepts.md)
109
124
*[Build and register APIs with the Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md)
110
125
*[Govern APIs with the Azure API Center extension for Visual Studio Code](govern-apis-vscode-extension.md)
111
-
*[Enable and view API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)
126
+
*[Enable API Center portal view in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)
Copy file name to clipboardExpand all lines: articles/api-center/enable-api-center-portal-vs-code-extension.md
+36-6Lines changed: 36 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Enable enterprise developers to view the enterprise's API Center po
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: how-to
7
-
ms.date: 03/20/2025
7
+
ms.date: 05/27/2025
8
8
ms.author: danlep
9
9
ms.custom:
10
10
# Customer intent: As an API program manager, I want to enable an API catalog so that app developers in my organization can discover and consume the APIs in my organization's API center without needing to manage the API inventory itself.
@@ -19,6 +19,8 @@ This article shows how to provide enterprise developers access to the Azure API
19
19
20
20
## Prerequisites
21
21
22
+
### For API center administrators
23
+
22
24
* An API center in your Azure subscription. If you haven't created one already, see [Quickstart: Create your API center](set-up-api-center.md).
23
25
24
26
* Permissions to create an app registration in a Microsoft Entra tenant associated with your Azure subscription, and permissions to grant access to data in your API center.
@@ -27,10 +29,13 @@ This article shows how to provide enterprise developers access to the Azure API
27
29
28
30
*[Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center)
29
31
32
+
> [!NOTE]
33
+
> Where noted, certain features are available only in the Azure API Center extension's pre-release version. [!INCLUDE [vscode-extension-prerelease-features](includes/vscode-extension-prerelease-features.md)]
30
34
31
-
The following Visual Studio Code extension is optional:
35
+
The following Visual Studio Code extensions are optional:
32
36
33
37
*[Microsoft Kiota extension](https://marketplace.visualstudio.com/items?itemName=ms-graph.kiota) - to generate API clients
38
+
* GitHub Copilot and GitHub Copilot Chat, provided with [access to GitHub Copilot](https://code.visualstudio.com/docs/copilot/setup) - to use language model tools in agent mode for discovering APIs
34
39
35
40
## Steps for API center administrators to enable access to API Center portal view
36
41
@@ -48,12 +53,10 @@ Enterprise developers must sign in with a Microsoft account to see the API Cente
48
53
49
54
## Steps for enterprise developers to access the API Center portal view
50
55
51
-
Developers can follow these steps to connect and sign in to view an API Center portal view using the Visual Studio Code extension. Settings to connect to the API center need to be provided by the API center administrator.
56
+
Developers can follow these steps to connect and sign in to an API Center portal view using the Visual Studio Code extension. Settings to connect to the API center need to be provided by the API center administrator. After connecting, developers can discover and consume the APIs in the API center.
52
57
53
58
### Connect to an API center
54
59
55
-
1. Install the pre-release version of the [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center) for Visual Studio Code.
56
-
57
60
1. In Visual Studio Code, in the Activity Bar on the left, select API Center.
58
61
59
62
:::image type="content" source="media/enable-api-center-portal-vs-code-extension/api-center-activity-bar.png" alt-text="Screenshot of the API Center icon in the Activity Bar.":::
@@ -66,7 +69,7 @@ Developers can follow these steps to connect and sign in to view an API Center p
66
69
1. The directory (tenant) ID from the app registration configured by the administrator in the previous section.
67
70
68
71
> [!TIP]
69
-
> An API center administrator needs to provide these connection details to developers, or provide a direct link in the following format:
72
+
> An API center administrator needs to provide the preceding connection details to developers, or provide a direct link in the following format:
After you connect to the API center, the name of the API center appears in the API Center portal view.
@@ -90,6 +93,33 @@ The API Center portal view helps enterprise developers discover API details and
90
93
***Generate Markdown** - Generate API documentation in Markdown format
91
94
***OpenAPI documentation** - View the documentation for an API definition and try operations in a Swagger UI (only available for OpenAPI definitions)
92
95
96
+
## Use language model tools
97
+
98
+
In the pre-release version of the Azure API Center extension, developers with access to the API Center portal view can add API Center language model tools to use in GitHub Copilot's agent mode. [Learn more about using tools in agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode#_agent-mode-tools).
99
+
100
+
The API Center tools can be used in agent mode to help search for APIs and API versions, API definitions and specifications, deployments, and more using natural language prompts.
101
+
102
+
To add and use API Center language mode tools in GitHub Copilot's agent mode:
103
+
104
+
1.[Connect to an API center](#create-microsoft-entra-app-registration) as described in a previous section.
105
+
1. Open GitHub Copilot Chat in Visual Studio Code.
106
+
1. Set the mode of GitHub Copilot Chat to **Agent**.
107
+
1. Select the **Tools** icon in the chat window.
108
+
109
+
:::image type="content" source="media/enable-api-center-portal-vs-code-extension/language-model-tools.png" alt-text="Screenshot of GitHub Copilot chat window in Visual Studio Code.":::
110
+
111
+
1. Select one or more API Center tools to be available in the chat.
112
+
113
+
:::image type="content" source="media/enable-api-center-portal-vs-code-extension/api-center-tools.png" alt-text="Screenshot of selecting API Center tools in Visual Studio Code.":::
114
+
115
+
1. Enter a prompt in the chat window to use the available tools. For example:
116
+
117
+
```copilot-prompt
118
+
Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.
119
+
```
120
+
121
+
1. Review the responses from GitHub Copilot Chat. Continue with the conversation to refine the results or ask follow-up questions.
Copy file name to clipboardExpand all lines: articles/api-center/includes/api-center-portal-app-registration.md
+22-4Lines changed: 22 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,28 @@ author: dlepow
6
6
7
7
ms.service: azure-api-center
8
8
ms.topic: include
9
-
ms.date: 03/20/2025
9
+
ms.date: 05/28/2025
10
10
ms.author: danlep
11
11
ms.custom: Include file
12
12
---
13
13
14
14
First configure an app registration in your Microsoft Entra ID tenant. The app registration enables the API Center portal to access data from your API center on behalf of a signed-in user.
15
15
16
+
API Center can set up the app registration automatically, or you can create the app registration manually.
17
+
18
+
#### Set up the app registration automatically
19
+
20
+
To set up the app registration automatically, follow these steps:
21
+
22
+
1. In the [Azure portal](https://portal.azure.com), navigate to your API center.
23
+
1. In the left-hand menu, select **API Center portal** > **Settings**.
24
+
1. On the **Identity provider** tab, select **Start set up**.
25
+
1. Select **Save + publish**.
26
+
27
+
#### Set up the app registration manually
28
+
29
+
If you want to create the app registration manually, follow these steps:
30
+
16
31
1. In the [Azure portal](https://portal.azure.com), navigate to **Microsoft Entra ID** > **App registrations**.
17
32
1. Select **+ New registration**.
18
33
1. On the **Register an application** page, set the values as follows:
@@ -23,12 +38,15 @@ First configure an app registration in your Microsoft Entra ID tenant. The app r
23
38
Enter the URI of your API Center portal deployment, in the following form: `https://<service-name>.portal.<location>.azure-api-center.ms`. Replace `<service name>` and `<location>` with the name of your API center and the location where it's deployed, Example: `https://myapicenter.portal.eastus.azure-api-center.ms`.
24
39
1. Select **Register**.
25
40
26
-
When enabling the API Center portal in the Visual Studio Code extension for API Center, also configure the following redirect URIs.
41
+
#### Configure additional redirect URIs for VS Code extension
42
+
43
+
When enabling the API Center portal view in the Visual Studio Code extension for API Center, also configure the following redirect URIs in the app registration:
27
44
28
-
1. On the **Manage** > **Authentication** page, Select **Add a platform** and select **Mobile and desktop applications**.
45
+
1. In the [Azure portal](https://portal.azure.com), navigate to your app registration.
46
+
1. On the **Manage** > **Authentication** page, select **Add a platform** and select **Mobile and desktop applications**.
29
47
1. Configure the following three custom redirect URIs:<br/>
Replace `<application-client-id>` with the application (client) ID of this app. You can find this value on the **Overview** page.
52
+
Replace `<application-client-id>` with the application (client) ID of this app. You can find this value on the **Overview** page of the app registration.
Copy file name to clipboardExpand all lines: articles/azure-resource-manager/bicep/bicep-extension.md
+1-4Lines changed: 1 addition & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,16 +3,13 @@ title: Use extensions in Bicep
3
3
description: This article describes how to use Bicep extensions.
4
4
ms.topic: conceptual
5
5
ms.custom: devx-track-bicep
6
-
ms.date: 04/09/2025
6
+
ms.date: 05/14/2025
7
7
---
8
8
9
9
# Use Bicep extensions
10
10
11
11
Bicep was initially created to enhance the authoring experience compared to Azure Resource Manager JSON templates, simplifying the deployment and management of Azure resources. Bicep extensions build on this foundation, enabling Bicep files to reference resources beyond the scope of Azure Resource Manager. This article describes how to use Bicep extensions.
12
12
13
-
> [!NOTE]
14
-
> The experimental feature `extensibility` must be enabled from the [Bicep config file](./bicep-config.md#enable-experimental-features) to use this feature.
description: Describes the functions to use in a Bicep file to retrieve deployment information.
4
4
ms.topic: reference
5
5
ms.custom: devx-track-bicep
6
-
ms.date: 02/12/2025
6
+
ms.date: 05/16/2025
7
7
---
8
8
9
9
# Deployment functions for Bicep
@@ -14,18 +14,26 @@ This article describes the Bicep functions for getting values related to the cur
14
14
15
15
`deployer()`
16
16
17
-
Returns the information about the current deploymentprincipal.
17
+
Returns information about the principal (identity) that initiated the current deployment. The principal can be a user, service principal, or managed identity, depending on how the deployment was started.
For more information about Azure identities, see [What is an Azure Active Directory identity?](/azure/active-directory/fundamentals/active-directory-whatis).
59
+
49
60
## deployment
50
61
51
62
`deployment()`
@@ -141,7 +152,7 @@ The preceding example returns the following object:
141
152
142
153
`environment()`
143
154
144
-
Returns information about the Azure environment used for deployment. The `environment()` function is not aware of resource configurations. It can only return a single default DNS suffix for each resource type.
155
+
Returns information about the Azure environment used for deployment. The `environment()` function isn't aware of resource configurations. It can only return a single default DNS suffix for each resource type.
Copy file name to clipboardExpand all lines: articles/azure-resource-manager/bicep/bicep-import.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Imports in Bicep
3
3
description: This article describes how to import shared functionality and namespaces in Bicep.
4
4
ms.topic: conceptual
5
5
ms.custom: devx-track-bicep
6
-
ms.date: 12/06/2024
6
+
ms.date: 05/16/2025
7
7
---
8
8
9
9
# Imports in Bicep
@@ -47,6 +47,8 @@ Only statements that were [exported](#export-variables-types-and-functions) in t
47
47
48
48
You can use functionality that was imported from another file without restrictions. For example, you can use imported variables anywhere that a variable declared in-file would normally be valid.
49
49
50
+
Starting with [Bicep CLI version 0.31.X](https://github.com/Azure/bicep/releases/tag/v0.31.34), variables imported from other Bicep files are accessible within your user-defined functions, just like variables defined locally. For more information, see [User-defined functions](./user-defined-functions.md#define-functions).
0 commit comments