Migrate Sphere to TypeSpec - #29989
Draft
JiaSeng-v wants to merge 1 commit into
Draft
Conversation
Contributor
|
Azure Pipelines: Successfully started running 1 pipeline(s). There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Az.Sphere module to align with a TypeSpec-based generation workflow, including new TypeSpec configuration files and regenerated module artifacts (manifest, solution, and help content).
Changes:
- Added TypeSpec emitter configuration for the Sphere module (
tspconfig.yaml,tsp-location.yaml) and supporting resources. - Refreshed Az.Sphere module artifacts (module manifest, solution structure, generated metadata).
- Regenerated reference help/docs content, including updated
-SubscriptionIddescriptions andGet-AzSphereCatalogparameter set naming.
Reviewed changes
Copilot reviewed 70 out of 70 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Sphere/Sphere/help/Update-AzSphereProduct.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Update-AzSphereDeviceGroup.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Update-AzSphereDevice.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Update-AzSphereCatalog.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Remove-AzSphereProduct.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Remove-AzSphereDeviceGroup.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Remove-AzSphereCatalog.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/New-AzSphereProductDefaultDeviceGroup.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/New-AzSphereProduct.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/New-AzSphereImage.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/New-AzSphereDeviceGroup.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/New-AzSphereDeviceCapabilityImage.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/New-AzSphereDevice.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/New-AzSphereDeployment.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/New-AzSphereCatalog.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Invoke-AzSphereCountProductDevice.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Invoke-AzSphereCountDeviceGroupDevice.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Invoke-AzSphereCountCatalogDevice.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereProduct.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereImage.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereDeviceGroup.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereDevice.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereDeployment.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereCertificateProof.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereCertificateCertChain.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereCertificate.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereCatalogDeviceInsight.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereCatalogDeviceGroup.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereCatalogDevice.md | Adds UUID note to -SubscriptionId help text |
| src/Sphere/Sphere/help/Get-AzSphereCatalog.md | Regenerated help; parameter set headings/metadata updated |
| src/Sphere/Sphere/ChangeLog.md | Adds an “Upcoming Release” entry for the generation update |
| src/Sphere/Sphere/Az.Sphere.psd1 | Regenerated manifest (generation date, Az.Accounts minimum, formatting) |
| src/Sphere/Sphere.sln | Solution updated (new folder/project GUIDs/configs); BOM/first-line changed |
| src/Sphere/Sphere.Autorest/tspconfig.yaml | New TypeSpec PowerShell emitter configuration for Sphere |
| src/Sphere/Sphere.Autorest/tsp-location.yaml | New TypeSpec source repo/commit/location lock |
| src/Sphere/Sphere.Autorest/resources/README.md | New resources folder documentation |
| src/Sphere/Sphere.Autorest/README.md | Removes legacy AutoRest YAML configuration block |
| src/Sphere/Sphere.Autorest/Properties/AssemblyInfo.cs | New generated assembly metadata for Sphere.Autorest |
| src/Sphere/Sphere.Autorest/generate-info.json | Regenerated generation ID |
| src/Sphere/Sphere.Autorest/docs/Update-AzSphereProduct.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Update-AzSphereDeviceGroup.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Update-AzSphereDevice.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Update-AzSphereCatalog.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Remove-AzSphereProduct.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Remove-AzSphereDeviceGroup.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Remove-AzSphereCatalog.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/New-AzSphereProductDefaultDeviceGroup.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/New-AzSphereProduct.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/New-AzSphereImage.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/New-AzSphereDeviceGroup.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/New-AzSphereDeviceCapabilityImage.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/New-AzSphereDevice.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/New-AzSphereDeployment.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/New-AzSphereCatalog.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Invoke-AzSphereCountProductDevice.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Invoke-AzSphereCountDeviceGroupDevice.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Invoke-AzSphereCountCatalogDevice.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereProduct.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereImage.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereDeviceGroup.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereDevice.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereDeployment.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereCertificateProof.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereCertificateCertChain.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereCertificate.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereCatalogDeviceInsight.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereCatalogDeviceGroup.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereCatalogDevice.md | Adds UUID note to -SubscriptionId docs text |
| src/Sphere/Sphere.Autorest/docs/Get-AzSphereCatalog.md | Regenerated docs; parameter set headings updated |
| src/Sphere/Sphere.Autorest/docs/Az.Sphere.md | Regenerated module documentation header metadata |
Suppressed comments (3)
src/Sphere/Sphere/help/Get-AzSphereCatalog.md:27
- This syntax heading labels the resource-group-scoped list parameter set as
List, but the cmdlet defines that parameter set asList1(the one requiring-ResourceGroupName). The heading should match the actual parameter set name.
src/Sphere/Sphere.Autorest/docs/Get-AzSphereCatalog.md:31 - This syntax heading labels the resource-group-scoped list parameter set as
List, but the cmdlet defines that parameter set asList1(the one requiring-ResourceGroupName). The heading should match the actual parameter set name.
### List
src/Sphere/Sphere/help/Get-AzSphereCatalog.md:169
-ResourceGroupNameis shown as belonging to parameter setsGet, List, but in the cmdlet it belongs toGet, List1(the list parameter set that requires-ResourceGroupName). This mismatch makes the help inaccurate.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+1
to
3
|
|
||
| Microsoft Visual Studio Solution File, Format Version 12.00 | ||
| # Visual Studio Version 17 |
| ## SYNTAX | ||
|
|
||
| ### List (Default) | ||
| ### List1 (Default) |
| ## SYNTAX | ||
|
|
||
| ### List (Default) | ||
| ### List1 (Default) |
|
|
||
| ### -SubscriptionId | ||
| The ID of the target subscription. | ||
| The value must be an UUID. |
| - Additional information about change #1 | ||
| --> | ||
| ## Upcoming Release | ||
| * Internal code generation updated. No user-facing changes in this release. |
|
|
||
| ### -SubscriptionId | ||
| The ID of the target subscription. | ||
| The value must be an UUID. |
Member
|
/azp run |
Contributor
|
Azure Pipelines: Successfully started running 3 pipeline(s). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.