[Az.Databricks] Update generation tool version: autorest.powershell v3->v4#28554
[Az.Databricks] Update generation tool version: autorest.powershell v3->v4#28554lijinpei2008 wants to merge 11 commits intomainfrom
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
|
To the author of the pull request, |
There was a problem hiding this comment.
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
added
the
autorest v4 migration
| [Microsoft.Azure.PowerShell.Cmdlets.Databricks.Category('Body')] | ||
| [System.Boolean] | ||
| # [System.Management.Automation.SwitchParameter] | ||
| [System.Management.Automation.SwitchParameter] |
There was a problem hiding this comment.
why change the type from boolean to switch?
There was a problem hiding this comment.
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.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
|
||
| ### -AutomaticClusterUpdate | ||
| Status of automated cluster updates feature. | ||
| . |
There was a problem hiding this comment.
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.
|
|
||
| ### -EnhancedSecurityCompliance | ||
| Status of Compliance Security Profile feature. | ||
| . |
There was a problem hiding this comment.
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.
|
|
||
| ### -EnhancedSecurityMonitoring | ||
| Status of Enhanced Security Monitoring feature. | ||
| . |
There was a problem hiding this comment.
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.
|
|
||
| ### -AutomaticClusterUpdate | ||
| Status of automated cluster updates feature. | ||
| . |
There was a problem hiding this comment.
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.
|
|
||
| ### -EnhancedSecurityCompliance | ||
| Status of Compliance Security Profile feature. | ||
| . |
There was a problem hiding this comment.
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.
|
|
||
| ### -EnhancedSecurityMonitoring | ||
| Status of Enhanced Security Monitoring feature. | ||
| . |
There was a problem hiding this comment.
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.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
| } | ||
|
|
||
| It 'Delete' { | ||
| It 'Delete' -skip { |
There was a problem hiding this comment.
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.
| It 'Delete' -skip { | |
| It 'Delete' { |
| ### -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 |
There was a problem hiding this comment.
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.
| --> | ||
| ## 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). |
There was a problem hiding this comment.
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.
| ### -AutomaticClusterUpdate | ||
| Status of automated cluster updates feature. | ||
| . | ||
|
|
||
| ```yaml | ||
| Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.AutomaticClusterUpdateValue | ||
| Type: System.String |
There was a problem hiding this comment.
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.
|
|
||
| ```yaml | ||
| Type: System.Collections.Hashtable | ||
| Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] |
There was a problem hiding this comment.
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.
| Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] | |
| Type: System.Nullable[System.Boolean] |
| } | ||
|
|
||
| It 'OutboundNetworkDependenciesEndpointList' { | ||
| It 'OutboundNetworkDependenciesEndpointList' -skip { |
There was a problem hiding this comment.
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.
| It 'OutboundNetworkDependenciesEndpointList' -skip { | |
| It 'OutboundNetworkDependenciesEndpointList' { |
| ### -AutomaticClusterUpdate | ||
| Status of automated cluster updates feature. | ||
| . | ||
|
|
||
| ```yaml | ||
| Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.AutomaticClusterUpdateValue | ||
| Type: System.String |
There was a problem hiding this comment.
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.
| "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]'." |
There was a problem hiding this comment.
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.
|
|
||
| ### -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 |
There was a problem hiding this comment.
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.
JunKai-v
force-pushed
the
jinpei/main/Databricks-v4
branch
from
f6e601a to
5e6da5d
Compare
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
| [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}, |
There was a problem hiding this comment.
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.
| [assembly: System.Reflection.AssemblyFileVersionAttribute("1.10.0")] | ||
| [assembly: System.Reflection.AssemblyVersionAttribute("1.10.0")] |
There was a problem hiding this comment.
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).
| [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")] |
| "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]'." |
There was a problem hiding this comment.
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.
| [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'"))] |
There was a problem hiding this comment.
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.
| [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'"))] |
| - ManagedResourceGroupId | ||
| labels: | ||
| ManagedResourceGroupId: Managed Resource Group ID | ||
|
|
There was a problem hiding this comment.
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.
| # Generate a helper cmdlet to construct WorkspaceProviderAuthorization objects | |
| # so users can easily create authorization entries to pass into workspace cmdlets. |
| [Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.ComplianceSecurityProfileValue] | ||
| # Status of Compliance Security Profile feature. | ||
| [System.String] | ||
| # . |
There was a problem hiding this comment.
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.
| # . | |
| # Specifies whether the enhanced security compliance profile is enabled for the workspace. |
| ### -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 |
There was a problem hiding this comment.
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.
|
|
||
| # Version number of this module. | ||
| ModuleVersion = '1.10.1' | ||
| ModuleVersion = '1.10.0' |
There was a problem hiding this comment.
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).
| $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' |
There was a problem hiding this comment.
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.
| [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'"))] |
There was a problem hiding this comment.
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.
| [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'"))] |
JunKai-v
force-pushed
the
jinpei/main/Databricks-v4
branch
from
10c139e to
c8b6c53
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 52 out of 54 changed files in this pull request and generated 8 comments.
You can also share your feedback on Copilot code review. Take the survey.
|
|
||
| ```yaml | ||
| Type: System.Collections.Hashtable | ||
| Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] |
There was a problem hiding this comment.
The help metadata exposes an assembly-qualified CLR type (System.Private.CoreLib, Version=9.0.0.0, ...) for -EnableSystemAssignedIdentity. This is noisy and brittle (and can change across runtimes); help should use a stable type name like System.Nullable[System.Boolean] (or System.Boolean). Consider adjusting the generator template or post-processing to strip assembly details.
| Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] | |
| Type: System.Nullable[System.Boolean] |
| .Example | ||
| Update-AzDatabricksVNetPeering -Name vnet-peering-t1 -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db -AllowForwardedTraffic $True | ||
| .Example | ||
| Get-AzDatabricksVNetPeering -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db -Name vnet-peering-t1 | Update-AzDatabricksVNetPeering -AllowGatewayTransit $true |
There was a problem hiding this comment.
In the comment-based help examples, -AllowForwardedTraffic $True / -AllowGatewayTransit $true no longer matches the cmdlet signature (these parameters are now SwitchParameter). Please update the examples to the new switch usage so users don’t copy/paste a non-working example.
| ### -AutomaticClusterUpdate | ||
| Status of automated cluster updates feature. | ||
| . | ||
|
|
||
| ```yaml | ||
| Type: Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.AutomaticClusterUpdateValue | ||
| Type: System.String | ||
| Parameter Sets: (All) | ||
| Aliases: AutomaticClusterUpdateValue |
There was a problem hiding this comment.
The parameter description is just "." which is not meaningful user-facing help text. Please restore a descriptive sentence (e.g., explain the feature/valid values) so Get-Help output remains useful.
| ### -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 | ||
| Aliases: AutomaticClusterUpdateValue |
There was a problem hiding this comment.
The parameter description is just "." which doesn’t meet the repo’s reference help quality bar (it’s effectively a placeholder). Please replace it with a real description of what the parameter does/what values are expected.
| [Parameter(ParameterSetName='CreateExpanded')] | ||
| [Alias('EnhancedSecurityMonitoringValue')] | ||
| [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}, | ||
|
|
||
| [Parameter()] | ||
| [Parameter(ParameterSetName='CreateExpanded')] | ||
| [Alias('AutomaticClusterUpdateValue')] | ||
| [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.AutomaticClusterUpdateValue])] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Databricks.PSArgumentCompleterAttribute("Enabled", "Disabled")] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Databricks.Category('Body')] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.AutomaticClusterUpdateValue] | ||
| # Status of automated cluster updates feature. | ||
| [System.String] | ||
| # . | ||
| ${AutomaticClusterUpdate}, | ||
|
|
||
| [Parameter()] | ||
| [Parameter(ParameterSetName='CreateExpanded')] | ||
| [Alias('ComplianceSecurityProfileComplianceStandard')] | ||
| [AllowEmptyCollection()] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Databricks.PSArgumentCompleterAttribute("NONE", "HIPAA", "PCI_DSS")] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Databricks.Category('Body')] | ||
| [System.String[]] | ||
| # Compliance standards associated with the workspace. | ||
| ${ComplianceStandard}, | ||
|
|
||
| [Parameter()] | ||
| [Parameter(ParameterSetName='CreateExpanded')] | ||
| [Alias('ComplianceSecurityProfileValue')] | ||
| [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.ComplianceSecurityProfileValue])] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Databricks.PSArgumentCompleterAttribute("Enabled", "Disabled")] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Databricks.Category('Body')] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Databricks.Support.ComplianceSecurityProfileValue] | ||
| # Status of Compliance Security Profile feature. | ||
| [System.String] | ||
| # . |
There was a problem hiding this comment.
These comment-based help annotations were changed to # . for user-facing parameters (placeholder text). Since this file feeds help generation, please replace the placeholder with real parameter descriptions to keep generated docs usable.
| --- | ||
| Module Name: Az.Databricks | ||
| Module Guid: c594b6a2-7da1-44cb-97a4-cdb8632b8090 | ||
| Module Guid: b5f7bf84-2742-4cda-8375-3a0cb2e78145 |
There was a problem hiding this comment.
The documentation module GUID (b5f7bf84-...) doesn't match the actual module GUID in the manifest (fd603f36-... in src/Databricks/Databricks/Az.Databricks.psd1). This mismatch can cause confusion and may break tooling that expects the docs header to align with the shipped module identity. Please keep the doc GUID consistent with the module manifest GUID.
| Module Guid: b5f7bf84-2742-4cda-8375-3a0cb2e78145 | |
| Module Guid: fd603f36-2742-4cda-8375-3a0cb2e78145 |
| @@ -1,5 +1,5 @@ | |||
| # Test | |||
| This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `../custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. | |||
| This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `..\custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. | |||
There was a problem hiding this comment.
This README uses Windows-style relative paths (..\custom) inside Markdown inline code. These paths aren’t portable and won’t work as links/copy-paste on non-Windows. Prefer POSIX-style ../custom in documentation.
| @@ -8,4 +8,4 @@ This directory contains the documentation of the cmdlets for the `Az.Databricks` | |||
| - Packaged: yes | |||
|
|
|||
| ## Details | |||
| The process of documentation generation loads `Az.Databricks` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. No newline at end of file | |||
| The process of documentation generation loads `Az.Databricks` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder. No newline at end of file | |||
There was a problem hiding this comment.
This docs README uses Windows-style paths (..\examples, ..\exports, ..\custom) in Markdown. These are not portable and are inconsistent with typical repo docs conventions; prefer ../examples, ../exports, ../custom.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Description
Preannouncement PR:
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.