Remove obsolete Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 script and modernize template for TypeSpec #53543

Copilot · 2025-10-28T21:37:58Z

Plan to address issue: Invoke-TypeSepcDataPlaneGenerateSDKPackage.ps1 is not using new emitter path

Based on the issue discussion and team decision:

Original prompt

This section details on the original issue you should resolve

<issue_title>Invoke-TypeSepcDataPlaneGenerateSDKPackage.ps1 is not using new emitter path</issue_title>
<issue_description>tsp-client init was updated to automatically use the new emitter path for new services. We need to investigate why this script is not doing that.</issue_description>

Comments on the Issue (you are @copilot in this section)
@jsquire Do we even need this script? There seem to be so many scripts like this floating around and I'm not sure where many are used. @JoshLove-msft @raych1 do you have context as to where this script is used? If it is not needed for the pipeline automation, agreed we can probably remove it and any references to it. @JoshLove-msft Here is where it is referenced https://github.com/Azure/azure-sdk-for-net/blob/9b64c749219efbaafc48a578fba59c2f8a60fecc/doc/DataPlaneCodeGeneration/AzureSDKPackage_Setup.md. I don't know if we are at the point yet where the REST spec pipeline automation can fully replace this script which sets up the scaffolding for a brand new service library. That said, it doesn't do much more than tsp-client init, so maybe we can just recommend that instead. @raych1 This script isn't used by the REST spec pipeline automation. I agreed that it could be replaced by calling `tsp-client init` directly. @JoshLove-msft We will update the docs to recommend either using `tsp-client init` or just manually create the tsp-location.yaml and will delete this script.

Fixes Invoke-TypeSepcDataPlaneGenerateSDKPackage.ps1 is not using new emitter path #53507

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

… and update documentation - Deleted eng/scripts/automation/Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 as it is not using the new emitter path - Updated doc/DataPlaneCodeGeneration/AzureSDKPackage_Setup.md to recommend using tsp-client init or manually creating tsp-location.yaml - Added guidance on required emitterPackageJsonPath property for new services Co-authored-by: JoshLove-msft <[email protected]>

JoshLove-msft · 2025-10-28T21:56:33Z

doc/DataPlaneCodeGeneration/AzureSDKPackage_Setup.md

 We will use the Azure SDK template [Azure.Template](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template) to create the initial project skeleton for SDKs generated from TypeSpec.

-You can run `eng\scripts\automation\Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1` to generate the starting SDK client library package directly as following:
+### Option 1: Using tsp-client init (Recommended)


@copilot let's just delete this file. We already have a separate doc that provides the same info.

Done. Deleted AzureSDKPackage_Setup.md and updated the reference in AzureSDKGeneration_Prerequistites.md to point to AzureSDKCodeGeneration_DataPlane_Quickstart.md instead (commit 869fba0).

- Deleted doc/DataPlaneCodeGeneration/AzureSDKPackage_Setup.md as requested - content is covered in AzureSDKCodeGeneration_DataPlane_Quickstart.md - Updated reference in AzureSDKGeneration_Prerequistites.md to point to the quickstart guide instead Co-authored-by: JoshLove-msft <[email protected]>

JoshLove-msft · 2025-10-28T22:47:29Z

doc/DataPlaneCodeGeneration/AzureSDKGeneration_Prerequistites.md

 ## Set up SDK Project Folder

-You will need to generate the SDK library under an SDK project folder following the repository [guidelines](https://github.com/Azure/azure-sdk-for-net/blob/main/doc/DataPlaneCodeGeneration/AzureSDKPackage_Setup.md).
+You will need to generate the SDK library under an SDK project folder following the repository [guidelines](https://github.com/Azure/azure-sdk-for-net/blob/main/doc/DataPlaneCodeGeneration/AzureSDKCodeGeneration_DataPlane_Quickstart.md).


@copilot we should just remove this link as it is linking back to the same document where this md is hosted.

Done. Removed the circular link from the prerequisites doc (commit 4415299).

- Removed link from AzureSDKGeneration_Prerequistites.md that was linking back to AzureSDKCodeGeneration_DataPlane_Quickstart.md - The quickstart already references the prerequisites, so this created a circular reference Co-authored-by: JoshLove-msft <[email protected]>

JoshLove-msft · 2025-10-28T23:09:33Z

doc/DataPlaneCodeGeneration/AzureSDKGeneration_Prerequistites.md

 ## Set up SDK Project Folder

-You will need to generate the SDK library under an SDK project folder following the repository [guidelines](https://github.com/Azure/azure-sdk-for-net/blob/main/doc/DataPlaneCodeGeneration/AzureSDKPackage_Setup.md).
+You will need to generate the SDK library under an SDK project folder following the repository guidelines.


@copilot lets link to the template as an example. https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/template/Azure.Template.

Let's also update the template to remove autorest.md and instead add a tsp-location.yaml.

Done. Updated prerequisites doc to link to Azure.Template as an example. Also updated the template itself: removed autorest.md and added tsp-location.yaml with placeholder values (commit 088d0d6).

@copilot let's also remove <IncludeAutorestDependency>true</IncludeAutorestDependency> from the csproj

The comment appears incomplete. Should I remove <IncludeAutorestDependency>true</IncludeAutorestDependency> from the Azure.Template.csproj since we replaced autorest.md with tsp-location.yaml?

@copilot yes

Done. Removed IncludeAutorestDependency from Azure.Template.csproj (commit 136ee56).

@copilot let's also delete the local swagger folder in this project.

Done. Deleted the swagger folder from Azure.Template (commit bcf2541).

- Added link to Azure.Template in AzureSDKGeneration_Prerequistites.md as an example - Removed autorest.md from Azure.Template (obsolete for TypeSpec) - Added tsp-location.yaml to Azure.Template with placeholder values as a template for new services Co-authored-by: JoshLove-msft <[email protected]>

- Removed IncludeAutorestDependency property since template now uses TypeSpec with tsp-location.yaml instead of autorest.md Co-authored-by: JoshLove-msft <[email protected]>

- Removed sdk/template/Azure.Template/src/swagger folder as it's no longer needed for TypeSpec-based generation Co-authored-by: JoshLove-msft <[email protected]>

JoshLove-msft · 2025-10-29T00:01:47Z

sdk/template/Azure.Template/tsp-location.yaml

+# This is a template tsp-location.yaml file for TypeSpec-based SDK generation
+# Replace the placeholder values with your actual TypeSpec project information
+
+directory: specification/<service-name>/<typespec-project-folder>


@copilot we should point to this https://github.com/Azure/azure-rest-api-specs/tree/main/specification/widget/data-plane/WidgetAnalytics

Done. Updated the directory to point to specification/widget/data-plane/WidgetAnalytics (commit de01e0c).

- Updated directory to point to specification/widget/data-plane/WidgetAnalytics as a concrete example instead of placeholder values Co-authored-by: JoshLove-msft <[email protected]>

JoshLove-msft · 2025-10-29T01:29:19Z

sdk/template/Azure.Template/tsp-location.yaml

+# Replace the placeholder values with your actual TypeSpec project information
+
+directory: specification/widget/data-plane/WidgetAnalytics
+commit: <commit-hash-from-azure-rest-api-specs>


Update to new commit once #53550 is resolved

@copilot update to use the spec from here Azure/azure-rest-api-specs#38490

Added reference to PR 38490 with a TODO comment to update the commit hash once the PR is merged (commit 8b7371e).

- Added TODO comment to update commit once PR 38490 is merged - Updated placeholder commit reference to indicate it should come from PR 38490 Co-authored-by: JoshLove-msft <[email protected]>

Copilot · 2025-11-05T17:12:48Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

https://api.github.com/repos/Azure/azure-rest-api-specs/pulls/38490
- Triggering command: curl -s REDACTED (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Initial plan

60e0ec1

Copilot AI assigned Copilot and JoshLove-msft Oct 28, 2025

Copilot started work on behalf of JoshLove-msft October 28, 2025 21:38 View session

Copilot AI changed the title ~~[WIP] Fix Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 emitter path issue~~ Remove obsolete Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 and update setup docs Oct 28, 2025

Copilot finished work on behalf of JoshLove-msft October 28, 2025 21:45

Copilot AI requested a review from JoshLove-msft October 28, 2025 21:45

JoshLove-msft reviewed Oct 28, 2025

View reviewed changes

Copilot started work on behalf of JoshLove-msft October 28, 2025 21:57 View session

Copilot AI changed the title ~~Remove obsolete Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 and update setup docs~~ Remove obsolete Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 script and clean up docs Oct 28, 2025

Copilot AI requested a review from JoshLove-msft October 28, 2025 22:02

Copilot finished work on behalf of JoshLove-msft October 28, 2025 22:02

JoshLove-msft reviewed Oct 28, 2025

View reviewed changes

Copilot started work on behalf of JoshLove-msft October 28, 2025 22:47 View session

Copilot AI requested a review from JoshLove-msft October 28, 2025 22:51

Copilot finished work on behalf of JoshLove-msft October 28, 2025 22:51

JoshLove-msft reviewed Oct 28, 2025

View reviewed changes

Copilot started work on behalf of JoshLove-msft October 28, 2025 23:10 View session

Copilot AI changed the title ~~Remove obsolete Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 script and clean up docs~~ Remove obsolete Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 script and modernize template for TypeSpec Oct 28, 2025

Copilot AI requested a review from JoshLove-msft October 28, 2025 23:15

Copilot finished work on behalf of JoshLove-msft October 28, 2025 23:15

Copilot started work on behalf of JoshLove-msft October 28, 2025 23:15 View session

Copilot finished work on behalf of JoshLove-msft October 28, 2025 23:18

Copilot started work on behalf of JoshLove-msft October 28, 2025 23:19 View session

Remove IncludeAutorestDependency from Azure.Template csproj

136ee56

- Removed IncludeAutorestDependency property since template now uses TypeSpec with tsp-location.yaml instead of autorest.md Co-authored-by: JoshLove-msft <[email protected]>

Copilot finished work on behalf of JoshLove-msft October 28, 2025 23:23

Copilot started work on behalf of JoshLove-msft October 28, 2025 23:24 View session

Delete swagger folder from Azure.Template

bcf2541

- Removed sdk/template/Azure.Template/src/swagger folder as it's no longer needed for TypeSpec-based generation Co-authored-by: JoshLove-msft <[email protected]>

Copilot finished work on behalf of JoshLove-msft October 28, 2025 23:27

JoshLove-msft reviewed Oct 29, 2025

View reviewed changes

Copilot started work on behalf of JoshLove-msft October 29, 2025 00:02 View session

Update tsp-location.yaml to reference widget example

de01e0c

- Updated directory to point to specification/widget/data-plane/WidgetAnalytics as a concrete example instead of placeholder values Co-authored-by: JoshLove-msft <[email protected]>

Copilot AI requested a review from JoshLove-msft October 29, 2025 00:06

Copilot finished work on behalf of JoshLove-msft October 29, 2025 00:06

JoshLove-msft reviewed Oct 29, 2025

View reviewed changes

Copilot started work on behalf of JoshLove-msft November 5, 2025 17:07 View session

Reference azure-rest-api-specs PR 38490 in tsp-location.yaml

8b7371e

- Added TODO comment to update commit once PR 38490 is merged - Updated placeholder commit reference to indicate it should come from PR 38490 Co-authored-by: JoshLove-msft <[email protected]>

Copilot AI requested a review from JoshLove-msft November 5, 2025 17:12

Copilot finished work on behalf of JoshLove-msft November 5, 2025 17:13

Remove obsolete Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 script and modernize template for TypeSpec #53543

Are you sure you want to change the base?

Remove obsolete Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 script and modernize template for TypeSpec #53543

Uh oh!

Conversation

Copilot AI commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comments on the Issue (you are @copilot in this section)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

JoshLove-msft Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Nov 5, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Oct 28, 2025 •

edited

Loading

JoshLove-msft Oct 28, 2025 •

edited

Loading