Migrate Elastic to TypeSpec - #29990
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. |
Member
|
/azp run |
Contributor
|
Azure Pipelines: Successfully started running 3 pipeline(s). |
Contributor
There was a problem hiding this comment.
Pull request overview
Migrates the Az.Elastic module’s generation workflow from the previous AutoRest README-based configuration to a TypeSpec (tspconfig.yaml + tsp-location.yaml) configuration, and updates the module’s generated artifacts and documentation accordingly.
Changes:
- Added TypeSpec PowerShell emitter configuration and pinned the Azure REST API specs commit for Elastic.
- Updated module metadata/artifacts (solution wiring, manifest dependency, assembly metadata, generation info, changelog).
- Regenerated Elastic cmdlet markdown help content (help + docs copies).
Reviewed changes
Copilot reviewed 38 out of 38 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Elastic/Elastic/help/Update-AzElasticTagRule.md | Regenerated cmdlet help content for Update-AzElasticTagRule. |
| src/Elastic/Elastic/help/Update-AzElasticOpenAi.md | Regenerated cmdlet help content for Update-AzElasticOpenAi. |
| src/Elastic/Elastic/help/Update-AzElasticMonitoredSubscription.md | Regenerated cmdlet help content and examples for Update-AzElasticMonitoredSubscription. |
| src/Elastic/Elastic/help/Update-AzElasticMonitor.md | Regenerated cmdlet help content for Update-AzElasticMonitor. |
| src/Elastic/Elastic/help/Update-AzElasticExternalUser.md | Regenerated cmdlet help content for Update-AzElasticExternalUser. |
| src/Elastic/Elastic/help/Remove-AzElasticMonitoredSubscription.md | Regenerated cmdlet help content for Remove-AzElasticMonitoredSubscription. |
| src/Elastic/Elastic/help/New-AzElasticTagRule.md | Regenerated cmdlet help content for New-AzElasticTagRule. |
| src/Elastic/Elastic/help/New-AzElasticOpenAi.md | Regenerated cmdlet help content for New-AzElasticOpenAi. |
| src/Elastic/Elastic/help/New-AzElasticMonitor.md | Regenerated cmdlet help content for New-AzElasticMonitor. |
| src/Elastic/Elastic/help/New-AzElasticExternalUser.md | Regenerated cmdlet help content for New-AzElasticExternalUser. |
| src/Elastic/Elastic/help/Get-AzElasticVersion.md | Regenerated cmdlet help content and sample output for Get-AzElasticVersion. |
| src/Elastic/Elastic/help/Get-AzElasticResubscribeOrganization.md | Regenerated cmdlet help content for Get-AzElasticResubscribeOrganization. |
| src/Elastic/Elastic/help/Get-AzElasticOrganizationElasticToAzureSubscriptionMapping.md | Regenerated cmdlet help content for Get-AzElasticOrganizationElasticToAzureSubscriptionMapping. |
| src/Elastic/Elastic/help/Get-AzElasticMonitoredSubscription.md | Regenerated cmdlet help content for Get-AzElasticMonitoredSubscription. |
| src/Elastic/Elastic/help/Get-AzElasticMonitor.md | Regenerated cmdlet help content for Get-AzElasticMonitor. |
| src/Elastic/Elastic/help/Az.Elastic.md | Regenerated module help index content for Az.Elastic. |
| src/Elastic/Elastic/ChangeLog.md | Added/updated upcoming release entry for Elastic. |
| src/Elastic/Elastic/Az.Elastic.psd1 | Updated module manifest metadata (generation date, Az.Accounts required version). |
| src/Elastic/Elastic.sln | Updated solution project reference GUID for generated Az.Elastic project. |
| src/Elastic/Elastic.Autorest/tspconfig.yaml | Added TypeSpec PowerShell emitter configuration and directives for Elastic. |
| src/Elastic/Elastic.Autorest/tsp-location.yaml | Added pinned azure-rest-api-specs repo + commit + directory for Elastic. |
| src/Elastic/Elastic.Autorest/README.md | Removed old AutoRest YAML configuration section (moving to TypeSpec config). |
| src/Elastic/Elastic.Autorest/Properties/AssemblyInfo.cs | Updated assembly metadata/header and title string. |
| src/Elastic/Elastic.Autorest/generate-info.json | Updated generation tracking identifier. |
| src/Elastic/Elastic.Autorest/docs/Update-AzElasticTagRule.md | Regenerated cmdlet docs content for Update-AzElasticTagRule. |
| src/Elastic/Elastic.Autorest/docs/Update-AzElasticOpenAi.md | Regenerated cmdlet docs content for Update-AzElasticOpenAi. |
| src/Elastic/Elastic.Autorest/docs/Update-AzElasticMonitoredSubscription.md | Regenerated cmdlet docs content for Update-AzElasticMonitoredSubscription. |
| src/Elastic/Elastic.Autorest/docs/Update-AzElasticMonitor.md | Regenerated cmdlet docs content for Update-AzElasticMonitor. |
| src/Elastic/Elastic.Autorest/docs/Update-AzElasticExternalUser.md | Regenerated cmdlet docs content for Update-AzElasticExternalUser. |
| src/Elastic/Elastic.Autorest/docs/Remove-AzElasticMonitoredSubscription.md | Regenerated cmdlet docs content for Remove-AzElasticMonitoredSubscription. |
| src/Elastic/Elastic.Autorest/docs/New-AzElasticTagRule.md | Regenerated cmdlet docs content for New-AzElasticTagRule. |
| src/Elastic/Elastic.Autorest/docs/New-AzElasticOpenAi.md | Regenerated cmdlet docs content for New-AzElasticOpenAi. |
| src/Elastic/Elastic.Autorest/docs/New-AzElasticMonitor.md | Regenerated cmdlet docs content for New-AzElasticMonitor. |
| src/Elastic/Elastic.Autorest/docs/New-AzElasticExternalUser.md | Regenerated cmdlet docs content for New-AzElasticExternalUser. |
| src/Elastic/Elastic.Autorest/docs/Get-AzElasticResubscribeOrganization.md | Regenerated cmdlet docs content for Get-AzElasticResubscribeOrganization. |
| src/Elastic/Elastic.Autorest/docs/Get-AzElasticOrganizationElasticToAzureSubscriptionMapping.md | Regenerated cmdlet docs content for Get-AzElasticOrganizationElasticToAzureSubscriptionMapping. |
| src/Elastic/Elastic.Autorest/docs/Get-AzElasticMonitor.md | Regenerated cmdlet docs content for Get-AzElasticMonitor. |
| src/Elastic/Elastic.Autorest/docs/Az.Elastic.md | Regenerated module docs index content for Az.Elastic. |
Suppressed comments (12)
src/Elastic/Elastic/help/Update-AzElasticMonitoredSubscription.md:71
- Example 2 omits -ConfigurationName, but the cmdlet requires it (only 'default' is supported). As written, the example will fail when copy/pasted.
src/Elastic/Elastic/help/Update-AzElasticMonitoredSubscription.md:84 - Example 3 (pipeline) omits -ConfigurationName, but the cmdlet requires it (only 'default' is supported). As written, the example will fail when copy/pasted.
src/Elastic/Elastic/help/New-AzElasticOpenAi.md:41 - This parameter set syntax documents -Key as SecureString, but the generated cmdlet parameter is System.String. Please align the help with the actual signature.
src/Elastic/Elastic/help/New-AzElasticOpenAi.md:48 - This parameter set syntax documents -Key as SecureString, but the generated cmdlet parameter is System.String. Please align the help with the actual signature.
src/Elastic/Elastic/help/New-AzElasticOpenAi.md:152 - The -Key parameter type is documented as SecureString, but the generated cmdlet parameter is System.String. Please align the help output with the actual cmdlet signature.
src/Elastic/Elastic/help/Update-AzElasticOpenAi.md:27 - This parameter set syntax documents -Key as SecureString, but the generated cmdlet parameter is System.String. Please align the help with the actual signature.
src/Elastic/Elastic/help/Update-AzElasticOpenAi.md:34 - This parameter set syntax documents -Key as SecureString, but the generated cmdlet parameter is System.String. Please align the help with the actual signature.
src/Elastic/Elastic/help/Update-AzElasticOpenAi.md:108 - The -Key parameter type is documented as SecureString, but the generated cmdlet parameter is System.String. Please align the help output with the actual cmdlet signature.
src/Elastic/Elastic/help/New-AzElasticExternalUser.md:40 - This parameter set syntax documents -Password as SecureString, but the generated cmdlet parameter is System.String. Please align the help with the actual signature.
New-AzElasticExternalUser -InputObject <IElasticIdentity> [-EmailId <String>] [-FullName <String>]
[-Password <SecureString>] [-Role <String[]>] [-UserName <String>] [-DefaultProfile <PSObject>]
[-WhatIf] [-Confirm] [<CommonParameters>]
src/Elastic/Elastic/help/New-AzElasticExternalUser.md:167
- The parameter heading is corrupted ("###******"), and the type is documented as SecureString even though the generated cmdlet parameter is System.String. This breaks the rendered help and misdocuments the signature.
### -Password
Password of the user to be created or updated
```yaml
Type: System.Security.SecureString
src/Elastic/Elastic/help/Update-AzElasticExternalUser.md:40
- This parameter set syntax documents -Password as SecureString, but the generated cmdlet parameter is System.String. Please align the help with the actual signature.
src/Elastic/Elastic/help/Update-AzElasticExternalUser.md:167 - The parameter heading is corrupted ("###******"), and the type is documented as SecureString even though the generated cmdlet parameter is System.String. This breaks the rendered help and misdocuments the signature.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ## DESCRIPTION | ||
| Retrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user. | ||
| \>;\n /**\nRetrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user. |
|
|
||
| ## SYNOPSIS | ||
| Retrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user. | ||
| \>;\n /**\nRetrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user. |
Comment on lines
53
to
55
| ### [Get-AzElasticOrganizationElasticToAzureSubscriptionMapping](Get-AzElasticOrganizationElasticToAzureSubscriptionMapping.md) | ||
| Retrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user. | ||
| \>;\n /**\nRetrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user. | ||
|
|
| version | ||
| --------- | ||
| 8.15.2 (Latest) | ||
| 8.15.2 (Lattest) |
| ### Example 1: Enable monitoring for a subscription | ||
| ```powershell | ||
| Update-AzElasticMonitoredSubscription -ResourceGroupName "myResourceGroup" -MonitorName "myElasticMonitor" -ConfigurationName "12345678-1234-1234-1234-123456789012" -SubscriptionId "12345678-1234-1234-1234-123456789012" -Operation "Add" | ||
| Update-AzElasticMonitoredSubscription -ResourceGroupName "myResourceGroup" -MonitorName "myElasticMonitor" -SubscriptionId "12345678-1234-1234-1234-123456789012" -Operation "Add" |
| - Additional information about change #1 | ||
| --> | ||
| ## Upcoming Release | ||
| * Internal code generation updated. No user-facing changes in this release. |
Comment on lines
17
to
+20
| New-AzElasticOpenAi -IntegrationName <String> -MonitorName <String> -ResourceGroupName <String> | ||
| [-SubscriptionId <String>] [-Key <String>] [-OpenAiConnectorId <String>] [-OpenAiResourceEndpoint <String>] | ||
| [-OpenAiResourceId <String>] [-DefaultProfile <PSObject>] [-WhatIf] | ||
| [-Confirm] [<CommonParameters>] | ||
| [-SubscriptionId <String>] [-Key <SecureString>] [-OpenAiConnectorId <String>] | ||
| [-OpenAiResourceEndpoint <String>] [-OpenAiResourceId <String>] [-DefaultProfile <PSObject>] | ||
| [-WhatIf] [-Confirm] [<CommonParameters>] |
Comment on lines
17
to
+20
| Update-AzElasticOpenAi -IntegrationName <String> -MonitorName <String> -ResourceGroupName <String> | ||
| [-SubscriptionId <String>] [-Key <String>] [-OpenAiConnectorId <String>] [-OpenAiResourceEndpoint <String>] | ||
| [-OpenAiResourceId <String>] [-DefaultProfile <PSObject>] [-WhatIf] | ||
| [-Confirm] [<CommonParameters>] | ||
| [-SubscriptionId <String>] [-Key <SecureString>] [-OpenAiConnectorId <String>] | ||
| [-OpenAiResourceEndpoint <String>] [-OpenAiResourceId <String>] [-DefaultProfile <PSObject>] | ||
| [-WhatIf] [-Confirm] [<CommonParameters>] |
Comment on lines
17
to
20
| New-AzElasticExternalUser -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] | ||
| [-EmailId <String>] [-FullName <String>] [-Password <String>] [-Role <String[]>] [-UserName <String>] | ||
| [-EmailId <String>] [-FullName <String>] [-Password <SecureString>] [-Role <String[]>] [-UserName <String>] | ||
| [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] | ||
| ``` |
Comment on lines
17
to
20
| Update-AzElasticExternalUser -MonitorName <String> -ResourceGroupName <String> [-SubscriptionId <String>] | ||
| [-EmailId <String>] [-FullName <String>] [-Password <String>] [-Role <String[]>] [-UserName <String>] | ||
| [-EmailId <String>] [-FullName <String>] [-Password <SecureString>] [-Role <String[]>] [-UserName <String>] | ||
| [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>] | ||
| ``` |
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.