Merge pull request #294474 from MicrosoftDocs/main

2/11/2025 PM Publish

Author: Taojunshen

.openpublishing.redirection.json

@@ -5244,6 +5244,11 @@
       "redirect_url": "/azure/virtual-wan/virtual-wan-about",
       "redirect_document_id": false
     },
+    {
+      "source_path_from_root": "/articles/virtual-wan/openvpn-azure-ad-client.md",
+      "redirect_url": "/azure/virtual-wan/point-to-site-entra-vpn-client-windows",
+      "redirect_document_id": false
+    },
     {
       "source_path_from_root": "/articles/virtual-wan/high-availability-vpn-client.md",
       "redirect_url": "/azure/virtual-wan/global-hub-profile",

articles/active-directory-b2c/media/configure-security-analytics-sentinel/full-details.png

@@ -46,6 +46,8 @@
           href: synchronize-aws-gateway-apis.md
       - name: Build and register APIs - VS Code extension
         href: build-register-apis-vscode-extension.md
+      - name: Design and develop  APIs - GitHub Copilot for Azure
+        href: design-api-github-copilot-azure.md
       - name: Register APIs - GitHub Actions
         href: register-apis-github-actions.md
 - name: API governance

articles/active-directory-b2c/media/configure-security-analytics-sentinel/rule-crud.png

@@ -17,7 +17,6 @@ API producer developers in your organization can build and register APIs in your
 
 * 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.
 * Use GitHub Copilot to generate new OpenAPI specs from API code.
-* Use natural language prompts with the API Center plugin for GitHub Copilot for Azure to create new OpenAPI specs.
 
 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).
 
@@ -28,7 +27,6 @@ The following Visual Studio Code extensions are needed for the specified scenari
 * [GitHub Actions](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions) - to register APIs using a CI/CD pipeline with GitHub Actions
 * [Azure Pipelines](https://marketplace.visualstudio.com/items?itemName=ms-azure-devops.azure-pipelines) - to register APIs using a CI/CD pipeline with Azure Pipelines
 * [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) - to generate OpenAPI specification files from API code
-* [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)
 
 [!INCLUDE [vscode-extension-setup](includes/vscode-extension-setup.md)]  
 
@@ -64,33 +62,8 @@ Use the power of [GitHub Copilot](https://marketplace.visualstudio.com/items?ite
 
 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.
 
-## Generate OpenAPI spec using natural language prompts
-
-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.
-
-> [!NOTE]
-> This feature is available in the pre-release version of the API Center extension.
-
-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**. 
-
-    If no style guide is set, the default `spectral:oas` ruleset is used.
-1. In the chat panel, make a request in natural language to the `@azure` agent to describe what the API does. Example:
-
-    ```vscode
-    @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.
-    ```  
-
-    The agent responds with an OpenAPI specification document.
-
-    :::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.":::
-
-
-1. Review the generated output for accuracy and compliance with your API style guide. Refine the prompt if needed to regenerate.
-
-    > [!TIP]
-    > Effective prompts focus on an API's business requirements rather than implementation details. Shorter prompts sometimes work better than longer ones.
-1. When it meets your requirements, save the generated OpenAPI specification to a file. 
-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.
+> [!TIP]
+> 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).
 
 ## Related content
 

articles/active-directory-b2c/media/partner-akamai-secure-hybrid-access/akamai-b2c-saml-configuration.png

@@ -0,0 +1,83 @@
+---
+title: Develop APIs with GitHub Copilot for Azure - API Center plugin
+description: With AI assistance, API developers can use the Azure API Center plugin for GitHub Copilot for Azure to design and develop compliant APIs.
+author: dlepow
+ms.service: azure-api-center
+ms.topic: how-to
+ms.date: 02/10/2025
+ms.author: danlep 
+ms.collection: ce-skilling-ai-copilot
+ms.custom: 
+# 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.
+---
+
+# Design and develop APIs using API Center plugin for GitHub Copilot for Azure
+
+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).
+
+> [!NOTE]
+> This feature is available in the pre-release version of the API Center extension.
+
+[!INCLUDE [vscode-extension-basic-prerequisites](includes/vscode-extension-basic-prerequisites.md)]  
+* [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)
+   
+[!INCLUDE [vscode-extension-setup](includes/vscode-extension-setup.md)] 
+
+## Make request to the @azure agent
+
+Follow these steps to generate an OpenAPI specification using natural language prompts with GitHub Copilot for Azure:
+
+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**. 
+
+    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.
+1. In the chat panel, make a request in natural language to the `@azure` agent to describe what the API does. Example:
+
+    ```copilot-prompt
+    @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.
+    ```  
+
+    Copilot is powered by AI, so surprises and mistakes are possible. For more information, see Copilot FAQs.
+
+    The agent responds with an OpenAPI specification document.
+
+    :::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.":::
+
+1. Review the generated output for accuracy, completeness, and compliance with your API style guide. 
+
+    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.
+
+    > [!TIP]
+    > Effective prompts focus on an API's business requirements rather than implementation details. Shorter prompts sometimes work better than longer ones.
+
+1. When it meets your requirements, save the generated OpenAPI specification to a file.
+
+## Register the API in your API center
+
+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.
+
+
+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.
+
+1. Select **Manual**.
+
+1. Select the API center to register APIs with.
+
+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.
+
+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:
+
+1. Expand the API Center tree view to select the definition for the API version that you registered.
+
+1. Right-click on the definition, and select **Open API Documentation**. A new tab appears with the Swagger UI for the API definition.
+
+:::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.":::    
+
+## Related content
+
+* [Azure API Center - key concepts](key-concepts.md)
+* [Build and register APIs with the Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md)
+* [Discover and consume APIs with the Azure API Center extension for Visual Studio Code](discover-apis-vscode-extension.md)
+* [Govern APIs with the Azure API Center extension for Visual Studio Code](govern-apis-vscode-extension.md)
+* [Enable and view platform API catalog in Visual Studio Code](enable-platform-api-catalog-vscode-extension.md)
+* [Overview of GitHub Copilot for Azure](/azure/developer/github-copilot-azure/introduction)
+