Skip to content

[Az.Databricks] Update generation tool version: autorest.powershell v3->v4#28554

Open
lijinpei2008 wants to merge 10 commits intomainfrom
jinpei/main/Databricks-v4
Open

[Az.Databricks] Update generation tool version: autorest.powershell v3->v4#28554
lijinpei2008 wants to merge 10 commits intomainfrom
jinpei/main/Databricks-v4

Conversation

@lijinpei2008
Copy link
Contributor

@lijinpei2008 lijinpei2008 commented Sep 12, 2025

Description

Preannouncement PR:

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

@azure-client-tools-bot-prd
Copy link

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

@lijinpei2008 lijinpei2008 added the Contains Breaking Change This PR contains breaking change label Sep 12, 2025
@github-actions
Copy link

To the author of the pull request,
This PR was labeled "Breaking Change Release" because it contains breaking changes.

  • According to our policy, breaking changes can only take place during major release and they must be preannounced.
  • Please follow our guide on the detailed steps.
  • Required: Please fill in the task below to facilitate our contact,you will receive notifications related to breaking changes.

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 PR updates the Azure Databricks PowerShell module by upgrading the AutoRest PowerShell generation tool from version 3 to version 4. The update modernizes the code generation process and aligns with newer AutoRest standards while maintaining backward compatibility.

Key changes include:

  • Upgrade from AutoRest PowerShell v3 to v4 for code generation
  • Extensive parameter type updates from enum types to string types across cmdlets
  • Breaking change exception configurations for maintaining API compatibility
  • Test configuration updates and example corrections

Reviewed Changes

Copilot reviewed 45 out of 48 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tools/StaticAnalysis/Exceptions/Az.Databricks/BreakingChangeIssues.csv Adds comprehensive breaking change exceptions to maintain API compatibility during the tool upgrade
src/Databricks/Databricks/help/*.md Updates help documentation with corrected parameter types and improved descriptions
src/Databricks/Databricks.Autorest/test/*.ps1 Updates test cases to use new parameter syntax (switch parameters instead of boolean values)
src/Databricks/Databricks.Autorest/custom/*.ps1 Refactors custom cmdlet implementations to use string types and new parameter sets
src/Databricks/Databricks.Autorest/README.md Updates AutoRest configuration to remove v3-specific settings and directives
Comments suppressed due to low confidence (6)

@isra-fel isra-fel added the autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 label Oct 20, 2025
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Category('Body')]
[System.Boolean]
# [System.Management.Automation.SwitchParameter]
[System.Management.Automation.SwitchParameter]
Copy link
Collaborator

Choose a reason for hiding this comment

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

why change the type from boolean to switch?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @VeryEarly, this change in parameter type is due to the internals of Update-AzDatabricksVNetPeering. The AllowVirtualNetworkAccess parameter is defined as a SwitchParameter internally, so we're following the internal parameter type definition.

@isra-fel isra-fel added this to the Az 16.0.0 (TBD) milestone Jan 28, 2026
Copilot AI review requested due to automatic review settings February 6, 2026 04:10
@JunKai-v
Copy link
Contributor

JunKai-v commented Feb 6, 2026

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

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

Copilot reviewed 47 out of 50 changed files in this pull request and generated 6 comments.


### -AutomaticClusterUpdate
Status of automated cluster updates feature.
.
Copy link

Copilot AI Feb 6, 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 AutomaticClusterUpdate is over-simplified (just a period: "."). This should be replaced with a meaningful description explaining what the parameter does, such as "Status of automated cluster updates feature" or similar descriptive text that helps users understand the parameter's purpose.

Copilot generated this review using guidance from repository custom instructions.

### -EnhancedSecurityCompliance
Status of Compliance Security Profile feature.
.
Copy link

Copilot AI Feb 6, 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 EnhancedSecurityCompliance is over-simplified (just a period: "."). This should be replaced with a meaningful description such as "Status of Compliance Security Profile feature" or similar descriptive text that helps users understand the parameter's purpose.

Copilot generated this review using guidance from repository custom instructions.

### -EnhancedSecurityMonitoring
Status of Enhanced Security Monitoring feature.
.
Copy link

Copilot AI Feb 6, 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 EnhancedSecurityMonitoring is over-simplified (just a period: "."). This should be replaced with a meaningful description such as "Status of Enhanced Security Monitoring feature" or similar descriptive text that helps users understand the parameter's purpose.

Copilot generated this review using guidance from repository custom instructions.

### -AutomaticClusterUpdate
Status of automated cluster updates feature.
.
Copy link

Copilot AI Feb 6, 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 AutomaticClusterUpdate is over-simplified (just a period: "."). This should be replaced with a meaningful description such as "Status of automated cluster updates feature" or similar descriptive text that helps users understand the parameter's purpose.

Copilot generated this review using guidance from repository custom instructions.

### -EnhancedSecurityCompliance
Status of Compliance Security Profile feature.
.
Copy link

Copilot AI Feb 6, 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 EnhancedSecurityCompliance is over-simplified (just a period: "."). This should be replaced with a meaningful description such as "Status of Compliance Security Profile feature" or similar descriptive text that helps users understand the parameter's purpose.

Copilot generated this review using guidance from repository custom instructions.

### -EnhancedSecurityMonitoring
Status of Enhanced Security Monitoring feature.
.
Copy link

Copilot AI Feb 6, 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 EnhancedSecurityMonitoring is over-simplified (just a period: "."). This should be replaced with a meaningful description such as "Status of Enhanced Security Monitoring feature" or similar descriptive text that helps users understand the parameter's purpose.

Copilot generated this review using guidance from repository custom instructions.
Copilot AI review requested due to automatic review settings February 16, 2026 07:32
@JunKai-v
Copy link
Contributor

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

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

Copilot reviewed 46 out of 49 changed files in this pull request and generated 9 comments.

}

It 'Delete' {
It 'Delete' -skip {
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

The delete scenario test is now skipped, which reduces end-to-end coverage for Remove-AzDatabricksVNetPeering. If deletion is intentionally avoided in CI to prevent flakiness/resource leakage, please add an inline comment with the rationale and tracking issue; otherwise, consider keeping a cleanup/delete validation path enabled.

Suggested change
It 'Delete' -skip {
It 'Delete' {

Copilot uses AI. Check for mistakes.
Comment on lines 200 to +205
### -AutomaticClusterUpdate
Status of automated cluster updates feature.
.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.AutomaticClusterUpdateValue
Parameter Sets: (All)
Type: System.String
Parameter Sets: CreateExpanded
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

Several parameter descriptions in this reference doc were reduced to a single '.' (for example, AutomaticClusterUpdate). Please restore meaningful, user-facing descriptions and any allowed values.

Copilot generated this review using guidance from repository custom instructions.
-->
## Upcoming Release
* Update the deprecated-by-azversion and change-effective-date of breaking change announcements.
* Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249).
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

The changelog entry is too generic for users (it doesn’t describe what changed in the module). Please replace with user-facing, concrete changes (e.g., parameter/behavior changes in specific cmdlets) and include relevant issue references if applicable, per ChangeLog guidance.

Copilot generated this review using guidance from repository custom instructions.
Comment on lines 217 to +221
### -AutomaticClusterUpdate
Status of automated cluster updates feature.
.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.AutomaticClusterUpdateValue
Type: System.String
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

Several parameter descriptions were reduced to a single '.' (e.g., for AutomaticClusterUpdate). This makes the reference help unhelpful and violates the repo’s reference help documentation requirements. Please restore a meaningful description of what the parameter controls and any allowed values/behavior.

Copilot generated this review using guidance from repository custom instructions.

```yaml
Type: System.Collections.Hashtable
Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

The type shown for -EnableSystemAssignedIdentity is assembly-qualified (includes System.Private.CoreLib version/public key token), which is confusing/noisy in published docs. Please simplify this to a user-friendly type (e.g., Boolean/Boolean?) in the generated markdown.

Suggested change
Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Type: System.Nullable[System.Boolean]

Copilot uses AI. Check for mistakes.
}

It 'OutboundNetworkDependenciesEndpointList' {
It 'OutboundNetworkDependenciesEndpointList' -skip {
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

This test is now skipped, which reduces coverage for Get-AzDatabricksOutboundNetworkDependenciesEndpoint behavior. If it’s being skipped due to a known service/API limitation, please add an inline comment explaining why and (ideally) track it with an issue; otherwise, re-enable the test.

Suggested change
It 'OutboundNetworkDependenciesEndpointList' -skip {
It 'OutboundNetworkDependenciesEndpointList' {

Copilot uses AI. Check for mistakes.
Comment on lines 215 to +219
### -AutomaticClusterUpdate
Status of automated cluster updates feature.
.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.AutomaticClusterUpdateValue
Type: System.String
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

Several parameter descriptions in this reference doc were reduced to a single '.' (for example, AutomaticClusterUpdate). Please restore meaningful descriptions and expected values/behavior so the docs remain useful.

Copilot generated this review using guidance from repository custom instructions.
Comment on lines +135 to +139
"Az.Databricks","Update-AzDatabricksWorkspace","Update-AzDatabricksWorkspace","0","3000","The type of property 'EnableNoPublicIPType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]' to 'System.String'.","Change the type of property 'EnableNoPublicIPType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]'."
"Az.Databricks","Update-AzDatabricksWorkspace","Update-AzDatabricksWorkspace","0","3000","The type of property 'LoadBalancerIdType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]' to 'System.String'.","Change the type of property 'LoadBalancerIdType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]'."
"Az.Databricks","Update-AzDatabricksWorkspace","Update-AzDatabricksWorkspace","0","3000","The type of property 'PublicIPNameType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]' to 'System.String'.","Change the type of property 'PublicIPNameType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]'."
"Az.Databricks","Update-AzDatabricksWorkspace","Update-AzDatabricksWorkspace","0","3000","The type of property 'EncryptionType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]' to 'System.String'.","Change the type of property 'EncryptionType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]'."
"Az.Databricks","Update-AzDatabricksWorkspace","Update-AzDatabricksWorkspace","0","3000","The type of property 'StorageAccountNameType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]' to 'System.String'.","Change the type of property 'StorageAccountNameType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]'."
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

This exceptions list contains duplicate entries (e.g., the same property-type changes for EnableNoPublicIPType/LoadBalancerIdType/PublicIPNameType/EncryptionType/StorageAccountNameType appear multiple times). Please deduplicate the CSV so the suppression list stays maintainable and reviewers can more easily audit what’s being suppressed.

Copilot uses AI. Check for mistakes.
Comment on lines 199 to +205

### -AutomaticClusterUpdate
Status of automated cluster updates feature.
.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.AutomaticClusterUpdateValue
Parameter Sets: (All)
Type: System.String
Parameter Sets: CreateExpanded
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

Several parameter descriptions were reduced to a single '.' (for example, AutomaticClusterUpdate). Please restore meaningful, user-facing descriptions for these parameters in the reference help rather than placeholder punctuation.

Copilot generated this review using guidance from repository custom instructions.
@JunKai-v JunKai-v force-pushed the jinpei/main/Databricks-v4 branch from f6e601a to 5e6da5d Compare March 2, 2026 03:37
Copilot AI review requested due to automatic review settings March 2, 2026 09:03
@isra-fel
Copy link
Member

isra-fel commented Mar 2, 2026

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

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

Copilot reviewed 52 out of 54 changed files in this pull request and generated 21 comments.

Comment on lines +261 to 265
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.PSArgumentCompleterAttribute("Enabled", "Disabled")]
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.EnhancedSecurityMonitoringValue]
# Status of Enhanced Security Monitoring feature.
[System.String]
# .
${EnhancedSecurityMonitoring},
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

This parameter's comment was changed to # ., which will produce an empty/meaningless parameter description in generated help. Please replace the placeholder with a real description (or restore the prior text) so users understand what the parameter does.

Copilot uses AI. Check for mistakes.
Comment on lines +23 to +24
[assembly: System.Reflection.AssemblyFileVersionAttribute("1.10.0")]
[assembly: System.Reflection.AssemblyVersionAttribute("1.10.0")]
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

AssemblyVersion/AssemblyFileVersion were decreased from 1.10.1 to 1.10.0. Version numbers should not move backwards; this can cause assembly binding and packaging issues. Please revert to 1.10.1 (or bump forward consistently with the module manifest).

Suggested change
[assembly: System.Reflection.AssemblyFileVersionAttribute("1.10.0")]
[assembly: System.Reflection.AssemblyVersionAttribute("1.10.0")]
[assembly: System.Reflection.AssemblyFileVersionAttribute("1.10.1")]
[assembly: System.Reflection.AssemblyVersionAttribute("1.10.1")]

Copilot uses AI. Check for mistakes.
Comment on lines +135 to +139
"Az.Databricks","Update-AzDatabricksWorkspace","Update-AzDatabricksWorkspace","0","3000","The type of property 'EnableNoPublicIPType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]' to 'System.String'.","Change the type of property 'EnableNoPublicIPType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]'."
"Az.Databricks","Update-AzDatabricksWorkspace","Update-AzDatabricksWorkspace","0","3000","The type of property 'LoadBalancerIdType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]' to 'System.String'.","Change the type of property 'LoadBalancerIdType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]'."
"Az.Databricks","Update-AzDatabricksWorkspace","Update-AzDatabricksWorkspace","0","3000","The type of property 'PublicIPNameType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]' to 'System.String'.","Change the type of property 'PublicIPNameType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]'."
"Az.Databricks","Update-AzDatabricksWorkspace","Update-AzDatabricksWorkspace","0","3000","The type of property 'EncryptionType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]' to 'System.String'.","Change the type of property 'EncryptionType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]'."
"Az.Databricks","Update-AzDatabricksWorkspace","Update-AzDatabricksWorkspace","0","3000","The type of property 'StorageAccountNameType' of type 'Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]' to 'System.String'.","Change the type of property 'StorageAccountNameType' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.CustomParameterType]'."
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

This exceptions list contains duplicate entries: lines 135-139 are repeated verbatim starting at line 140. Duplicates add noise and make it harder to maintain/verify the suppression list; please remove the redundant rows.

Copilot uses AI. Check for mistakes.
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api202601.IWorkspace", "16.0.0", "2.0.0", "May 2026", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", DeprecatedOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization"), NewOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization The types of the properties will be changed from object to 'List'"))]
[CmdletBinding(DefaultParameterSetName = 'UpdateExpanded', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact = 'Medium')]
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace])]
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", "16.0.0", "2.0.0", "May 2026", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", DeprecatedOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization"), NewOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization The types of the properties will be changed from object to 'List'"))]
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

The breaking-change effective date is set to "May 2026". In this repo, breaking change attributes use a strict "YYYY/MM/DD" date format (e.g., "2025/11/03" in src/CloudService/CloudService.Autorest/custom/New-AzCloudService.ps1:25). Please update this value to the required format.

Suggested change
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", "16.0.0", "2.0.0", "May 2026", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", DeprecatedOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization"), NewOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization The types of the properties will be changed from object to 'List'"))]
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", "16.0.0", "2.0.0", "2026/05/01", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", DeprecatedOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization"), NewOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization The types of the properties will be changed from object to 'List'"))]

Copilot uses AI. Check for mistakes.
- ManagedResourceGroupId
labels:
ManagedResourceGroupId: Managed Resource Group ID

Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

A new model-cmdlet directive was added without an explanatory comment. In AutoRest README.md files, directives should be commented to explain the rationale/purpose so future maintainers can safely modify regeneration settings.

Suggested change
# Generate a helper cmdlet to construct WorkspaceProviderAuthorization objects
# so users can easily create authorization entries to pass into workspace cmdlets.

Copilot uses AI. Check for mistakes.
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.ComplianceSecurityProfileValue]
# Status of Compliance Security Profile feature.
[System.String]
# .
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

This parameter's comment was changed to # ., which will produce an empty/meaningless parameter description in generated help. Please replace the placeholder with a real description (or restore the prior text) so users understand what the parameter does.

Suggested change
# .
# Specifies whether the enhanced security compliance profile is enabled for the workspace.

Copilot uses AI. Check for mistakes.
Comment on lines 201 to +206
### -AutomaticClusterUpdate
Status of automated cluster updates feature.
.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.AutomaticClusterUpdateValue
Parameter Sets: (All)
Type: System.String
Parameter Sets: CreateExpanded
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

The parameter description is just ".", which renders as empty/meaningless in generated docs. Please restore a user-facing description (what the parameter controls and expected values) instead of a placeholder.

Copilot uses AI. Check for mistakes.

# Version number of this module.
ModuleVersion = '1.10.1'
ModuleVersion = '1.10.0'
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

ModuleVersion was decreased from 1.10.1 to 1.10.0. Module versions should be monotonically increasing; downgrading can break upgrade paths and packaging/version checks. Please restore the prior version (or bump forward if needed).

Copilot uses AI. Check for mistakes.
Comment on lines +3 to +6
$null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '..\bin\Az.Databricks.private.dll')

# Load the internal module
$internalModulePath = Join-Path $PSScriptRoot '../internal/Az.Databricks.internal.psm1'
$internalModulePath = Join-Path $PSScriptRoot '..\internal\Az.Databricks.internal.psm1'
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

These Join-Path child paths use Windows-style backslashes (e.g., '..\bin...'). This can break on non-Windows platforms because the backslash may be treated as a literal character. Prefer passing clean relative segments (e.g., '../bin/Az.Databricks.private.dll') or joining multiple segments so path separators are platform-correct.

Copilot uses AI. Check for mistakes.
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api202601.IWorkspace", "16.0.0", "2.0.0", "May 2026", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", DeprecatedOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization"), NewOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization The types of the properties will be changed from object to 'List'"))]
[CmdletBinding(DefaultParameterSetName = 'CreateExpanded', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact = 'Medium')]
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace])]
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", "16.0.0", "2.0.0", "May 2026", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", DeprecatedOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization"), NewOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization The types of the properties will be changed from object to 'List'"))]
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

The breaking-change effective date is set to "May 2026". In this repo, breaking change attributes use a strict "YYYY/MM/DD" date format (e.g., "2025/11/03" in src/CloudService/CloudService.Autorest/custom/New-AzCloudService.ps1:25). Please update this value to the required format.

Suggested change
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", "16.0.0", "2.0.0", "May 2026", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", DeprecatedOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization"), NewOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization The types of the properties will be changed from object to 'List'"))]
[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", "16.0.0", "2.0.0", "2026/05/01", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.IWorkspace", DeprecatedOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization"), NewOutputProperties = ("PrivateEndpointConnection, ComplianceSecurityProfileComplianceStandard, Authorization The types of the properties will be changed from object to 'List'"))]

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 Contains Breaking Change This PR contains breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants