Skip to content

Commit cf035de

Browse files
Merge branch 'main' of https://github.com/MicrosoftDocs/azure-docs-pr into ap
2 parents 445683b + 1276ff5 commit cf035de

File tree

410 files changed

+4243
-3763
lines changed

Some content is hidden

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

410 files changed

+4243
-3763
lines changed

.openpublishing.redirection.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5244,6 +5244,11 @@
52445244
"redirect_url": "/azure/virtual-wan/virtual-wan-about",
52455245
"redirect_document_id": false
52465246
},
5247+
{
5248+
"source_path_from_root": "/articles/virtual-wan/openvpn-azure-ad-client.md",
5249+
"redirect_url": "/azure/virtual-wan/point-to-site-entra-vpn-client-windows",
5250+
"redirect_document_id": false
5251+
},
52475252
{
52485253
"source_path_from_root": "/articles/virtual-wan/high-availability-vpn-client.md",
52495254
"redirect_url": "/azure/virtual-wan/global-hub-profile",
@@ -5923,6 +5928,16 @@
59235928
"source_path_from_root": "/articles/reliability/reliability-hdinsight-on-aks.md",
59245929
"redirect_url": "/azure/reliability/overview-reliability-guidance",
59255930
"redirect_document_id": false
5931+
},
5932+
{
5933+
"source_path_from_root": "/articles/managed-grafana/concept-role-based-access-control.md",
5934+
"redirect_url": "/azure/managed-grafana/how-to-manage-access-permissions-users-identities",
5935+
"redirect_document_id": false
5936+
},
5937+
{
5938+
"source_path_from_root": "/articles/managed-grafana/how-to-share-grafana-workspace.md",
5939+
"redirect_url": "/azure/managed-grafana/how-to-manage-access-permissions-users-identities",
5940+
"redirect_document_id": false
59265941
}
59275942
]
59285943
}

articles/api-center/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@
4646
href: synchronize-aws-gateway-apis.md
4747
- name: Build and register APIs - VS Code extension
4848
href: build-register-apis-vscode-extension.md
49+
- name: Design and develop APIs - GitHub Copilot for Azure
50+
href: design-api-github-copilot-azure.md
4951
- name: Register APIs - GitHub Actions
5052
href: register-apis-github-actions.md
5153
- name: API governance

articles/api-center/build-register-apis-vscode-extension.md

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ API producer developers in your organization can build and register APIs in your
1717

1818
* Add an existing API to an API center as a one-time operation, or integrate a development pipeline to register APIs as part of a CI/CD workflow.
1919
* Use GitHub Copilot to generate new OpenAPI specs from API code.
20-
* Use natural language prompts with the API Center plugin for GitHub Copilot for Azure to create new OpenAPI specs.
2120

2221
API consumer developers can also take advantage of features in the extension to [discover and consume APIs](discover-apis-vscode-extension.md) in the API center and ensure [API governance](govern-apis-vscode-extension.md).
2322

@@ -28,7 +27,6 @@ The following Visual Studio Code extensions are needed for the specified scenari
2827
* [GitHub Actions](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions) - to register APIs using a CI/CD pipeline with GitHub Actions
2928
* [Azure Pipelines](https://marketplace.visualstudio.com/items?itemName=ms-azure-devops.azure-pipelines) - to register APIs using a CI/CD pipeline with Azure Pipelines
3029
* [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) - to generate OpenAPI specification files from API code
31-
* [GitHub Copilot for Azure](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) - to generate OpenAPI specification files using the Azure API Center Plugin for [GitHub Copilot for Azure](/azure/developer/github-copilot-azure/introduction) (preview)
3230

3331
[!INCLUDE [vscode-extension-setup](includes/vscode-extension-setup.md)]
3432

@@ -64,33 +62,8 @@ Use the power of [GitHub Copilot](https://marketplace.visualstudio.com/items?ite
6462

6563
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.
6664

67-
## Generate OpenAPI spec using natural language prompts
68-
69-
The API Center plugin for [GitHub Copilot for Azure](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) (preview) helps you design new APIs starting from natural language prompts. With AI assistance, quickly generate an OpenAPI spec for API development that complies with your organization's standards.
70-
71-
> [!NOTE]
72-
> This feature is available in the pre-release version of the API Center extension.
73-
74-
1. If desired, set an active API style guide. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Set API Style Guide**, make a selection, and hit **Enter**.
75-
76-
If no style guide is set, the default `spectral:oas` ruleset is used.
77-
1. In the chat panel, make a request in natural language to the `@azure` agent to describe what the API does. Example:
78-
79-
```vscode
80-
@azure Generate OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards.
81-
```
82-
83-
The agent responds with an OpenAPI specification document.
84-
85-
:::image type="content" source="media/build-register-apis-vscode-extension/generate-api-specification.png" alt-text="Screenshot showing how to use @azure extension to generate an OpenAPI spec from a prompt.":::
86-
87-
88-
1. Review the generated output for accuracy and compliance with your API style guide. Refine the prompt if needed to regenerate.
89-
90-
> [!TIP]
91-
> Effective prompts focus on an API's business requirements rather than implementation details. Shorter prompts sometimes work better than longer ones.
92-
1. When it meets your requirements, save the generated OpenAPI specification to a file.
93-
1. Register the API with your API center. Select **Register your API in API Center** button in the chat panel, or select **Azure API Center: Register API** from the Command Palette, and follow the prompts.
65+
> [!TIP]
66+
> API developers can also generate new OpenAPI specs using natural language prompts with the API Center plugin for GitHub Copilot for Azure. [Learn more](design-api-github-copilot-azure.md).
9467
9568
## Related content
9669

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: Develop APIs with GitHub Copilot for Azure - API Center plugin
3+
description: With AI assistance, API developers can use the Azure API Center plugin for GitHub Copilot for Azure to design and develop compliant APIs.
4+
author: dlepow
5+
ms.service: azure-api-center
6+
ms.topic: how-to
7+
ms.date: 02/10/2025
8+
ms.author: danlep
9+
ms.collection: ce-skilling-ai-copilot
10+
ms.custom:
11+
# Customer intent: As an API developer, I want to use my Visual Studio Code environment and GitHub Copilot for Azure to generate Open API specs from natural language prompts.
12+
---
13+
14+
# Design and develop APIs using API Center plugin for GitHub Copilot for Azure
15+
16+
The API Center plugin for [GitHub Copilot for Azure](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) (preview) accelerates design and development of new APIs starting from natural language prompts. With AI assistance available through the API Center plugin combined with the API Center VS Code extension, simply describe your API and quickly generate an OpenAPI spec for API development that complies with your organization's standards. After you generate a compliant spec, you can register the API with your [API center](overview.md).
17+
18+
> [!NOTE]
19+
> This feature is available in the pre-release version of the API Center extension.
20+
21+
[!INCLUDE [vscode-extension-basic-prerequisites](includes/vscode-extension-basic-prerequisites.md)]
22+
* [GitHub Copilot for Azure](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) - to generate OpenAPI specification files using the Azure API Center Plugin for [GitHub Copilot for Azure](/azure/developer/github-copilot-azure/introduction) (preview)
23+
24+
[!INCLUDE [vscode-extension-setup](includes/vscode-extension-setup.md)]
25+
26+
## Make request to the @azure agent
27+
28+
Follow these steps to generate an OpenAPI specification using natural language prompts with GitHub Copilot for Azure:
29+
30+
1. If desired, set an active API style guide in the Azure API Center extension. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Set API Style Guide**, make a selection, and hit **Enter**.
31+
32+
If no style guide is set, the default `spectral:oas` ruleset is used. Learn more about [API specification linting](govern-apis-vscode-extension.md#api-design-conformance) using the API Center extension.
33+
1. In the chat panel, make a request in natural language to the `@azure` agent to describe what the API does. Example:
34+
35+
```copilot-prompt
36+
@azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.
37+
```
38+
39+
Copilot is powered by AI, so surprises and mistakes are possible. For more information, see Copilot FAQs.
40+
41+
The agent responds with an OpenAPI specification document.
42+
43+
:::image type="content" source="media/design-api-github-copilot-azure/generate-api-specification.png" alt-text="Screenshot showing how to use @azure extension to generate an OpenAPI spec from a prompt.":::
44+
45+
1. Review the generated output for accuracy, completeness, and compliance with your API style guide.
46+
47+
Refine the prompt if needed to regenerate the spec, or repeat the process using a different style guide that you set in the Azure API Center extension.
48+
49+
> [!TIP]
50+
> Effective prompts focus on an API's business requirements rather than implementation details. Shorter prompts sometimes work better than longer ones.
51+
52+
1. When it meets your requirements, save the generated OpenAPI specification to a file.
53+
54+
## Register the API in your API center
55+
56+
Use the Azure API Center extension for VS Code to register the API in your API center from the generated specification file. After registering the API, you can use the extension to view the API documentation, generate an HTTP client, perform further linting and analysis, and more.
57+
58+
59+
1. In VS Code, select **Register your API in API Center** button in the chat panel, or select **Azure API Center: Register API** from the Command Palette.
60+
61+
1. Select **Manual**.
62+
63+
1. Select the API center to register APIs with.
64+
65+
1. Answer prompts with information including API title, type, version title, version lifecycle, definition title, specification name, and definition (specification) file to complete API registration.
66+
67+
After the API is registered, you can perform various tasks using the extension. For example, [view API documentation](discover-apis-vscode-extension.md#view-api-documentation) in the Swagger UI:
68+
69+
1. Expand the API Center tree view to select the definition for the API version that you registered.
70+
71+
1. Right-click on the definition, and select **Open API Documentation**. A new tab appears with the Swagger UI for the API definition.
72+
73+
:::image type="content" source="media/design-api-github-copilot-azure/view-definition-swagger-ui.png" alt-text="Screenshot of the Swagger UI in the VS Code extension.":::
74+
75+
## Related content
76+
77+
* [Azure API Center - key concepts](key-concepts.md)
78+
* [Build and register APIs with the Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md)
79+
* [Discover and consume APIs with the Azure API Center extension for Visual Studio Code](discover-apis-vscode-extension.md)
80+
* [Govern APIs with the Azure API Center extension for Visual Studio Code](govern-apis-vscode-extension.md)
81+
* [Enable and view platform API catalog in Visual Studio Code](enable-platform-api-catalog-vscode-extension.md)
82+
* [Overview of GitHub Copilot for Azure](/azure/developer/github-copilot-azure/introduction)
83+

articles/api-center/includes/vscode-extension-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ ms.author: danlep
1111
ms.custom: Include file
1212
---
1313

14-
## Setup
14+
## Extension setup
1515

16-
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.
16+
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 listed in the Prerequisites.
1717

1818
> [!NOTE]
1919
> 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)]
186 KB
Loading

articles/api-center/overview.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom: references_regions
1414

1515
Azure API Center enables tracking all of your APIs in a centralized location for discovery, reuse, and governance. Use an API center to develop and maintain a structured and organized inventory of your organization's APIs - regardless of their type, lifecycle stage, or deployment location - along with related information such as version details, API definition files, and common metadata.
1616

17-
With an API center, stakeholders throughout your organization - including API program managers, IT administrators, application developers, and API developers - can discover, reuse, and govern APIs.
17+
With an API center, stakeholders throughout your organization - including API program managers, IT administrators, application developers, and API developers - can design, discover, reuse, and govern APIs.
1818

1919
> [!NOTE]
2020
> Azure API Center is a solution for design-time API governance and centralized API discovery. Azure also offers complementary services such as Azure API Management, a solution for runtime API governance and observability using an API gateway. [Learn more](frequently-asked-questions.yml#what-s-the-difference-between-azure-api-management-and-azure-api-center) about the differences and how Azure API Center and API Management can work together.
@@ -24,7 +24,7 @@ With an API center, stakeholders throughout your organization - including API pr
2424

2525
* **Create and maintain an organizational inventory​** - Organizations can build a **complete inventory of APIs** available in their organization. Register APIs managed in all of your API management solutions, including Azure API Management and platforms from other providers. Also include your unmanaged APIs and APIs under development. Foster communication and let API program managers and developers collaborate for increased API reuse, quality, security, compliance, and developer productivity.​
2626

27-
* **Govern your organization's APIs** - With more complete visibility into the APIs being produced and used within an organization, API program managers and IT administrators can govern this inventory to ensure it meets organizational standards by **defining custom metadata** and **analyzing API definitions** to enforce conformance to API style guidelines.​
27+
* **Govern your organization's APIs** - With more complete visibility into the APIs being developed and used within an organization, API program managers and IT administrators can govern this inventory to ensure it meets organizational standards by **defining custom metadata** and **analyzing API definitions** to enforce conformance to API style guidelines.​
2828

2929
* **Easy API discovery** - Organizations want to promote API reuse to maximize developer productivity and ensure developers are using the right APIs. Azure API Center helps program managers and developers discover the API inventory and filter using built-in and custom metadata. ​
3030

@@ -37,7 +37,9 @@ Create and use an API center for the following:
3737

3838
* **API inventory management** - API developers and API program managers can register all of your organization's APIs for inclusion in a centralized inventory using the Azure portal, the Azure CLI, developer tooling such as CI/CD pipelines, and links to API sources such as Azure API Management services.
3939

40-
* **API design and development** - With the [Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md), developers can register APIs directly from the same development environment where they create their APIs and apps. Developers can take advantage of the extension's integration with GitHub Copilot and GitHub Copilot for Azure to create API definitions from code or natural language descriptions.
40+
* **API design and development** - With the [Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md), developers can register APIs directly from the same development environment where they create their APIs and apps.
41+
42+
Developers can take advantage of the extension's integration with GitHub Copilot to [create API definitions from code](build-register-apis-vscode-extension.md#generate-openapi-spec-from-api-code) and with GitHub Copilot for Azure to [design APIs with AI assistance](design-api-github-copilot-azure.md).
4143

4244
* **Real-world API representation** - Add real-world information about each API including versions and definitions such as OpenAPI definitions. List API deployments and associate them with runtime environments, for example, representing Azure API Management or other API management solutions.
4345

articles/app-service/configure-authentication-oauth-tokens.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ From your client code (such as a mobile app or in-browser JavaScript), send an H
3737
When your provider's access token (not the [session token](#extend-session-token-expiration-grace-period)) expires, you need to reauthenticate the user before you use that token again. You can avoid token expiration by making a `GET` call to the `/.auth/refresh` endpoint of your application. When called, App Service automatically refreshes the access tokens in the [token store](overview-authentication-authorization.md#token-store) for the authenticated user. Subsequent requests for tokens by your app code get the refreshed tokens. However, for token refresh to work, the token store must contain [refresh tokens](/entra/identity-platform/refresh-tokens) for your provider. The way to get refresh tokens are documented by each provider, but the following list is a brief summary:
3838

3939
- **Google**: Append an `access_type=offline` query string parameter to your `/.auth/login/google` API call. For more information, see [Google Refresh Tokens](https://developers.google.com/identity/protocols/OpenIDConnect#refresh-tokens).
40-
- **Facebook**: Doesn't provide refresh tokens. Long-lived tokens expire in 60 days (see [Facebook Expiration and Extension of Access Tokens](https://developers.facebook.com/docs/facebook-login/access-tokens/expiration-and-extension)).
40+
- **Facebook**: Doesn't provide refresh tokens. Long-lived tokens expire in 60 days (see [Long-Lived Access Tokens](https://developers.facebook.com/docs/facebook-login/guides/access-tokens/get-long-lived/)).
4141
- **X**: Access tokens don't expire (see [OAuth FAQ](https://developer.x.com/en/docs/authentication/faq)).
4242
- **Microsoft**: In [https://resources.azure.com](https://resources.azure.com), do the following steps:
4343
1. At the top of the page, select **Read/Write**.

0 commit comments

Comments
 (0)