Replaced parameter EnableRbacAuthorization by DisableRbacAuthorization in New-AzKeyVault and Update-AzKeyVault
#24675
Conversation
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
️✔️Az.Accounts
️✔️Az.Compute
️✔️Az.CosmosDB
️✔️Az.EventHub
|
| Type | Cmdlet | Description | Remediation |
|---|---|---|---|
| Get-AzKeyVaultManagedHsmRegion | Get-AzKeyVaultManagedHsmRegion Changes the ConfirmImpact but does not set the SupportsShouldProcess property to true in the cmdlet attribute. | Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue | |
| Get-AzKeyVaultManagedHsmRegion | Get-AzKeyVaultManagedHsmRegion changes the confirm impact. Please ensure that the change in ConfirmImpact is justified | Verify that ConfirmImpact is changed appropriately by the cmdlet. It is very rare for a cmdlet to change the ConfirmImpact. |
⚠️ Windows PowerShell - Windows
| Type | Cmdlet | Description | Remediation |
|---|---|---|---|
| Get-AzKeyVaultManagedHsmRegion | Get-AzKeyVaultManagedHsmRegion Changes the ConfirmImpact but does not set the SupportsShouldProcess property to true in the cmdlet attribute. | Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue | |
| Get-AzKeyVaultManagedHsmRegion | Get-AzKeyVaultManagedHsmRegion changes the confirm impact. Please ensure that the change in ConfirmImpact is justified | Verify that ConfirmImpact is changed appropriately by the cmdlet. It is very rare for a cmdlet to change the ConfirmImpact. |
⚠️ Help Example Check
⚠️ PowerShell Core - Windows
Type Cmdlet Example Line RuleName Description Extent Remediation ⚠️ Update-AzKeyVault 1 1 Unassigned_Variable Get-AzKeyVault -VaultName $keyVaultName is a null-valued parameter value. -VaultName Assign value for $keyVaultName. ⚠️ Update-AzKeyVault 1 1 Unassigned_Variable Get-AzKeyVault -ResourceGroupName $resourceGroupName is a null-valued parameter value. -ResourceGroupName Assign value for $resourceGroupName. ⚠️ Update-AzKeyVault 2 1 Unassigned_Variable Get-AzKeyVault -VaultName $keyVaultName is a null-valued parameter value. -VaultName Assign value for $keyVaultName. ⚠️ Update-AzKeyVault 2 1 Unassigned_Variable Get-AzKeyVault -ResourceGroupName $resourceGroupName is a null-valued parameter value. -ResourceGroupName Assign value for $resourceGroupName. ⚠️ Update-AzKeyVault 3 1 Unassigned_Variable Get-AzKeyVault -VaultName $keyVaultName is a null-valued parameter value. -VaultName Assign value for $keyVaultName. ⚠️ Update-AzKeyVault 4 1 Unassigned_Variable Get-AzKeyVault -VaultName $keyVaultName is a null-valued parameter value. -VaultName Assign value for $keyVaultName.
⚠️ Windows PowerShell - Windows
Type Cmdlet Example Line RuleName Description Extent Remediation ⚠️ Update-AzKeyVault 1 1 Unassigned_Variable Get-AzKeyVault -VaultName $keyVaultName is a null-valued parameter value. -VaultName Assign value for $keyVaultName. ⚠️ Update-AzKeyVault 1 1 Unassigned_Variable Get-AzKeyVault -ResourceGroupName $resourceGroupName is a null-valued parameter value. -ResourceGroupName Assign value for $resourceGroupName. ⚠️ Update-AzKeyVault 2 1 Unassigned_Variable Get-AzKeyVault -VaultName $keyVaultName is a null-valued parameter value. -VaultName Assign value for $keyVaultName. ⚠️ Update-AzKeyVault 2 1 Unassigned_Variable Get-AzKeyVault -ResourceGroupName $resourceGroupName is a null-valued parameter value. -ResourceGroupName Assign value for $resourceGroupName. ⚠️ Update-AzKeyVault 3 1 Unassigned_Variable Get-AzKeyVault -VaultName $keyVaultName is a null-valued parameter value. -VaultName Assign value for $keyVaultName. ⚠️ Update-AzKeyVault 4 1 Unassigned_Variable Get-AzKeyVault -VaultName $keyVaultName is a null-valued parameter value. -VaultName Assign value for $keyVaultName.
️✔️Help File Existence Check
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️File Change Check
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️UX Metadata Check
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
⚠️ Test
⚠️ - Linux
Type Title Current Coverage Description ⚠️ Test Coverage Less Than 50% 22.09 % Test coverage for the module cannot be lower than 50%.
⚠️ - MacOS
Type Title Current Coverage Description ⚠️ Test Coverage Less Than 50% 22.09% Test coverage for the module cannot be lower than 50%.
⚠️ PowerShell Core - Windows
Type Title Current Coverage Description ⚠️ Test Coverage Less Than 50% 22.09% Test coverage for the module cannot be lower than 50%.
⚠️ Windows PowerShell - Windows
Type Title Current Coverage Description ⚠️ Test Coverage Less Than 50% 22.09% Test coverage for the module cannot be lower than 50%.
️✔️Az.ManagedServiceIdentity
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.Monitor
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.Network
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Test
️✔️ - Linux
️✔️ - MacOS
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.OperationalInsights
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.PrivateDns
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.Resources
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.ServiceBus
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Test
️✔️ - Linux
️✔️ - MacOS
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.Sql
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Test
️✔️ - Linux
️✔️ - MacOS
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.Storage
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
BethanyZhou
added
Breaking Change Release
|
To the author of the pull request, |
|
|
YanaXu
approved these changes
Apr 24, 2024
6 tasks
|
@YanaXu / @BethanyZhou ; can you please comment as to why did you need to remove the My team has release branches that contain usage of this flag, and the version of the Az PS Cmdlets is necessarily updated on build agents as a security measure, so we've had to make code changes to work around this. Leaving it in seems like a harmless thing to do, but removing it breaks users, so I'd like to understand the motivation. |
|
Hi @MattGal , thanks for asking. Azure Key Vault is migrating from vault access policy to an Azure role-based access control (Azure RBAC) permission model. Azure RBAC is the default and recommended authorization system for Azure Key Vault. See Migrate from vault access policy to an Azure role-based access control permission model. User had to specify EnableRbacAuthorization parameter explicitly before, which implies access policy is the default authorization systems. That's why we removed parameter EnableRbacAuthorization. Making it a no-op is an option but it's not a good practice for a new user. We preannounced the upcoming breaking change two sprints (almost two months) in advance to let user be aware of this and take actions when major version comes. |
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
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.