Skip to content

[BC]StackHCI Module Breaking Changes Announcement Date Update#29134

Open
JiaSeng-v wants to merge 1 commit intoAzure:mainfrom
JiaSeng-v:jiaseng/StackHCI-breakingchanges
Open

[BC]StackHCI Module Breaking Changes Announcement Date Update#29134
JiaSeng-v wants to merge 1 commit intoAzure:mainfrom
JiaSeng-v:jiaseng/StackHCI-breakingchanges

Conversation

@JiaSeng-v
Copy link
Contributor

@JiaSeng-v JiaSeng-v commented Feb 4, 2026

Description

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

Copilot AI review requested due to automatic review settings February 4, 2026 07:43
@JiaSeng-v JiaSeng-v added Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 labels Feb 4, 2026
@azure-client-tools-bot-prd
Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request updates the breaking change announcement dates for the Az.StackHCI module and adds several new cmdlets for MSI-based registration and Arc enablement functionality.

Changes:

  • Updated breaking change announcement dates from Azure PowerShell version 15.0.0 (November 2025) to version 16.0.0 (May 2026) across all breaking change directives in README.md
  • Added seven new cmdlets: Enable-ArcOnNodes, Invoke-MSIFlow, Invoke-MSIUnregistrationFlow, Test-ArcNodeClusterLink, Test-ClusterArcEnabled, Test-ClusterMsiSupport, and Test-ComputerNameHasDnsSuffix
  • Added new parameter -useStableAgentVersion to Register-AzStackHCI cmdlet to enable using the stable HCI Arc agent for server registration

Reviewed changes

Copilot reviewed 37 out of 37 changed files in this pull request and generated 15 comments.

Show a summary per file
File Description
src/StackHCI/StackHCI.Autorest/README.md Updated breaking change dates from 2025/11 to 2026/05 and version from 15.0.0 to 16.0.0 across 15 breaking change directives
src/StackHCI/StackHCI.Autorest/Properties/AssemblyInfo.cs Updated assembly version from 2.6.1 to 2.6.6
src/StackHCI/StackHCI/Az.StackHCI.psd1 Updated module manifest generation date, uncommented ScriptsToProcess and TypesToProcess, added new cmdlets to FunctionsToExport, updated Tags formatting
src/StackHCI/StackHCI.sln Updated project GUID reference for AutoRest project
src/StackHCI/StackHCI.Autorest/generate-info.json Updated generate_Id GUID
src/StackHCI/StackHCI/help/*.md Added help documentation files for 7 new cmdlets with incomplete placeholder content
src/StackHCI/StackHCI.Autorest/docs/*.md Added documentation files for 7 new cmdlets, updated module index, and added new parameter documentation to Register-AzStackHCI
src/StackHCI/StackHCI.Autorest/test/*.Tests.ps1 Added 7 new Pester test files for new cmdlets with placeholder/skipped test implementations
src/StackHCI/StackHCI.Autorest/examples/*.md Added 7 example documentation files with placeholder template content

Comment on lines +10 to +44
## SYNOPSIS

## SYNTAX

```
Test-ComputerNameHasDnsSuffix [-ComputerName] <String>
[<CommonParameters>]
```

## DESCRIPTION

## EXAMPLES

### Example 1: {{ Add title here }}
```powershell
{{ Add code here }}
```

```output
{{ Add output here }}
```

{{ Add description here }}

### Example 2: {{ Add title here }}
```powershell
{{ Add code here }}
```

```output
{{ Add output here }}
```

{{ Add description here }}

Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SYNOPSIS section is empty and contains placeholder examples with template text like '{{ Add title here }}' and '{{ Add code here }}'. According to the custom guideline 1000004, cmdlet reference documentation should avoid over-simplified descriptions. These should be properly documented with meaningful descriptions, real examples with actual code and output, and complete parameter descriptions before being included in a release.

Copilot generated this review using guidance from repository custom instructions.
Comment on lines +10 to +44
## SYNOPSIS

## SYNTAX

```
Test-ClusterMsiSupport [-ClusterNodeSession] <PSSession>
[<CommonParameters>]
```

## DESCRIPTION

## EXAMPLES

### Example 1: {{ Add title here }}
```powershell
{{ Add code here }}
```

```output
{{ Add output here }}
```

{{ Add description here }}

### Example 2: {{ Add title here }}
```powershell
{{ Add code here }}
```

```output
{{ Add output here }}
```

{{ Add description here }}

Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SYNOPSIS section is empty and contains placeholder examples with template text like '{{ Add title here }}' and '{{ Add code here }}'. According to the custom guideline 1000004, cmdlet reference documentation should avoid over-simplified descriptions. These should be properly documented with meaningful descriptions, real examples with actual code and output, and complete parameter descriptions before being included in a release.

Copilot generated this review using guidance from repository custom instructions.
Invoke-MSIFlow [-ClusterNodes] <Array> [-ClusterDNSSuffix] <String> [-ResourceId] <String>
[-RPAPIVersion] <String> [-TenantId] <String> [-Region] <String> [-ResourceGroupName] <String>
[-ResourceName] <String> [-SubscriptionId] <String> [-ClusterNodeSession] <PSSession>
[[-Credential] <PSCredential>] [[-Tag] <Hashtable>] [[-registrationOutput] <PSObject>]
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter name 'registrationOutput' does not follow PowerShell naming conventions. PowerShell cmdlet parameters should use PascalCase (also known as UpperCamelCase), not camelCase. This parameter should be named 'RegistrationOutput' to be consistent with PowerShell standards.

Copilot uses AI. Check for mistakes.
Accept wildcard characters: False
```

### -useStableAgentVersion
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter name 'useStableAgentVersion' does not follow PowerShell naming conventions. PowerShell cmdlet parameters should use PascalCase (also known as UpperCamelCase), not camelCase. This parameter should be named 'UseStableAgentVersion' to be consistent with other parameters in this cmdlet like 'UseDeviceAuthentication', 'IsWAC', 'RepairRegistration', etc.

Copilot uses AI. Check for mistakes.
Accept wildcard characters: False
```

### -useStableAgentVersion
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter name 'useStableAgentVersion' does not follow PowerShell naming conventions. PowerShell cmdlet parameters should use PascalCase (also known as UpperCamelCase), not camelCase. This parameter should be named 'UseStableAgentVersion' to be consistent with other parameters in this cmdlet.

Copilot uses AI. Check for mistakes.
Comment on lines +10 to +44
## SYNOPSIS

## SYNTAX

```
Test-ClusterArcEnabled [-ClusterNodes] <Array> [-ClusterDNSSuffix] <String> [-SubscriptionId] <String>
[-ArcResourceGroupName] <String> [[-Credential] <PSCredential>]
[<CommonParameters>]
```

## DESCRIPTION

## EXAMPLES

### Example 1: {{ Add title here }}
```powershell
{{ Add code here }}
```

```output
{{ Add output here }}
```

{{ Add description here }}

### Example 2: {{ Add title here }}
```powershell
{{ Add code here }}
```

```output
{{ Add output here }}
```

{{ Add description here }}
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SYNOPSIS section is empty and contains placeholder examples with template text like '{{ Add title here }}' and '{{ Add code here }}'. According to the custom guideline 1000004, cmdlet reference documentation should avoid over-simplified descriptions. These should be properly documented with meaningful descriptions, real examples with actual code and output, and complete parameter descriptions before being included in a release.

Copilot generated this review using guidance from repository custom instructions.
Comment on lines +10 to +44
## SYNOPSIS

## SYNTAX

```
Enable-ArcOnNodes [-ClusterNodes] <Array> [-ClusterDNSSuffix] <String> [-SubscriptionId] <String>
[-ResourceGroupName] <String> [-TenantId] <String> [-Location] <String> [-EnvironmentName] <String>
[-AccessToken] <String> [[-Credential] <PSCredential>] [[-UseStableAgent] <Boolean>]
[[-IsManagementNode] <Boolean>] [[-ComputerName] <String>]
[<CommonParameters>]
```

## DESCRIPTION

## EXAMPLES

### Example 1: {{ Add title here }}
```powershell
{{ Add code here }}
```

```output
{{ Add output here }}
```

{{ Add description here }}

### Example 2: {{ Add title here }}
```powershell
{{ Add code here }}
```

```output
{{ Add output here }}
```
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SYNOPSIS section is empty and contains placeholder examples with template text like '{{ Add title here }}' and '{{ Add code here }}'. According to the custom guideline 1000004, cmdlet reference documentation should avoid over-simplified descriptions. These should be properly documented with meaningful descriptions, real examples with actual code and output, and complete parameter descriptions before being included in a release.

Copilot generated this review using guidance from repository custom instructions.
Comment on lines +47 to +48
### -ComputerName

Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter description for 'ComputerName' is empty. According to custom guideline 1000004, cmdlet reference documentation should avoid over-simplified descriptions and provide meaningful parameter descriptions. This parameter should have a description explaining what the ComputerName represents and how it's used by this cmdlet.

Copilot generated this review using guidance from repository custom instructions.
Accept wildcard characters: False
```

### -registrationOutput
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter name 'registrationOutput' does not follow PowerShell naming conventions. PowerShell cmdlet parameters should use PascalCase (also known as UpperCamelCase), not camelCase. This parameter should be named 'RegistrationOutput' to be consistent with PowerShell standards and other parameters in this cmdlet like 'ClusterNodes', 'ResourceId', etc.

Copilot uses AI. Check for mistakes.
Invoke-MSIFlow [-ClusterNodes] <Array> [-ClusterDNSSuffix] <String> [-ResourceId] <String>
[-RPAPIVersion] <String> [-TenantId] <String> [-Region] <String> [-ResourceGroupName] <String>
[-ResourceName] <String> [-SubscriptionId] <String> [-ClusterNodeSession] <PSSession>
[[-Credential] <PSCredential>] [[-Tag] <Hashtable>] [[-registrationOutput] <PSObject>]
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter name 'registrationOutput' does not follow PowerShell naming conventions. PowerShell cmdlet parameters should use PascalCase (also known as UpperCamelCase), not camelCase. This parameter should be named 'RegistrationOutput' to be consistent with PowerShell standards.

Suggested change
[[-Credential] <PSCredential>] [[-Tag] <Hashtable>] [[-registrationOutput] <PSObject>]
[[-Credential] <PSCredential>] [[-Tag] <Hashtable>] [[-RegistrationOutput] <PSObject>]

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant