Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Az.Resources] skip client side validation for RoleAssignment & RoleDefinition commands #24037

Merged
merged 5 commits into from
Jan 26, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
skip client side validation for RoleAssignment commands
  • Loading branch information
NoriZC committed Jan 25, 2024
commit cc40e154a0c546a1341fda3f69f726ff67b0e4c3
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,9 @@ public class GetAzureRoleAssignmentCommand : ResourcesBaseCmdlet
HelpMessage = "If specified, also returns the subscription classic administrators as role assignments.")]
public SwitchParameter IncludeClassicAdministrators { get; set; }

[Parameter(Mandatory = false, HelpMessage = "If specified, skip client side scope validation.")]
public SwitchParameter SkipClientSideScopeValidation { get; set; }

#endregion


Expand Down Expand Up @@ -251,7 +254,10 @@ public override void ExecuteCmdlet()
WriteTerminatingError(ProjectResources.ScopeAndSubscriptionNeitherProvided);
}

AuthorizationClient.ValidateScope(options.Scope, true);
if (!SkipClientSideScopeValidation.IsPresent)
{
AuthorizationClient.ValidateScope(options.Scope, true);
}

List<PSRoleAssignment> ra = PoliciesClient.FilterRoleAssignments(options, DefaultProfile.DefaultContext.Subscription?.Id?.ToString());

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,9 @@ public class NewAzureRoleAssignmentCommand : ResourcesBaseCmdlet
[ValidateNotNullOrEmpty]
public SwitchParameter AllowDelegation { get; set; }

[Parameter(Mandatory = false, HelpMessage = "If specified, skip client side scope validation.")]
public SwitchParameter SkipClientSideScopeValidation { get; set; }

#endregion

public Guid RoleAssignmentId { get; set; } = default(Guid);
Expand Down Expand Up @@ -337,7 +340,10 @@ public override void ExecuteCmdlet()
WriteTerminatingError(ProjectResources.ScopeAndSubscriptionNeitherProvided);
}

AuthorizationClient.ValidateScope(parameters.Scope, true);
if (!SkipClientSideScopeValidation.IsPresent)
{
AuthorizationClient.ValidateScope(parameters.Scope, true);
}

WriteObject(PoliciesClient.CreateRoleAssignment(parameters, RoleAssignmentId));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,9 @@ public class RemoveAzureRoleAssignmentCommand : ResourcesBaseCmdlet
[Parameter(Position = 0, Mandatory = true, ValueFromPipeline = true, ParameterSetName = ParameterSet.RoleAssignment, HelpMessage = "Role Assignment.")]
public PSRoleAssignment InputObject { get; set; }

[Parameter(Mandatory = false, HelpMessage = "If specified, skip client side scope validation.")]
public SwitchParameter SkipClientSideScopeValidation { get; set; }

public override void ExecuteCmdlet()
{
IEnumerable<PSRoleAssignment> roleAssignments = null;
Expand Down Expand Up @@ -201,7 +204,11 @@ public override void ExecuteCmdlet()
WriteTerminatingError(ProjectResources.ScopeAndSubscriptionNeitherProvided);
}

AuthorizationClient.ValidateScope(options.Scope, true);
if (!SkipClientSideScopeValidation.IsPresent)
{
AuthorizationClient.ValidateScope(options.Scope, true);
}

ConfirmAction(
string.Format(ProjectResources.RemovingRoleAssignment, ObjectId, Scope, RoleDefinitionName),
ObjectId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ public class SetAzureRoleAssignmentCommand : ResourcesBaseCmdlet
[Parameter(Mandatory = true, ValueFromPipeline = true, ParameterSetName = ParameterSet.RoleAssignment, HelpMessage = "Role Assignment.")]
public PSRoleAssignment InputObject { get; set; }

[Parameter(Mandatory = false, HelpMessage = "If specified, skip client side scope validation.")]
public SwitchParameter SkipClientSideScopeValidation { get; set; }

[Parameter(Mandatory = false)]
public SwitchParameter PassThru { get; set; }
#endregion
Expand Down Expand Up @@ -95,7 +98,10 @@ public override void ExecuteCmdlet()
}

// Validate the request
AuthorizationClient.ValidateScope(parameters.Scope, false);
if (!SkipClientSideScopeValidation.IsPresent)
{
AuthorizationClient.ValidateScope(parameters.Scope, false);
}
bool isValidRequest = true;

// Check that only Description, Condition and ConditionVersion have been changed, if anything else is changed the whole request fails
Expand Down
61 changes: 44 additions & 17 deletions src/Resources/Resources/help/Get-AzRoleAssignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,107 +28,119 @@ Please notice that this cmdlet will mark `ObjectType` as `Unknown` in output if
### EmptyParameterSet (Default)
```
Get-AzRoleAssignment [-RoleDefinitionName <String>] [-IncludeClassicAdministrators]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ObjectIdParameterSet
```
Get-AzRoleAssignment -ObjectId <String> [-RoleDefinitionName <String>] [-ExpandPrincipalGroups]
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceGroupWithObjectIdParameterSet
```
Get-AzRoleAssignment -ObjectId <String> -ResourceGroupName <String> [-RoleDefinitionName <String>]
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceWithObjectIdParameterSet
```
Get-AzRoleAssignment -ObjectId <String> -ResourceGroupName <String> -ResourceName <String>
-ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>]
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ScopeWithObjectIdParameterSet
```
Get-AzRoleAssignment -ObjectId <String> [-RoleDefinitionName <String>] -Scope <String>
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### RoleIdWithScopeAndObjectIdParameterSet
```
Get-AzRoleAssignment [-ObjectId <String>] -RoleDefinitionId <Guid> [-Scope <String>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ResourceGroupWithSignInNameParameterSet
```
Get-AzRoleAssignment -SignInName <String> -ResourceGroupName <String> [-RoleDefinitionName <String>]
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceWithSignInNameParameterSet
```
Get-AzRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String>
-ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>]
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ScopeWithSignInNameParameterSet
```
Get-AzRoleAssignment -SignInName <String> [-RoleDefinitionName <String>] -Scope <String>
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### SignInNameParameterSet
```
Get-AzRoleAssignment -SignInName <String> [-RoleDefinitionName <String>] [-ExpandPrincipalGroups]
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceGroupWithSPNParameterSet
```
Get-AzRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> [-RoleDefinitionName <String>]
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceWithSPNParameterSet
```
Get-AzRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> -ResourceName <String>
-ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>]
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ScopeWithSPNParameterSet
```
Get-AzRoleAssignment -ServicePrincipalName <String> [-RoleDefinitionName <String>] -Scope <String>
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### SPNParameterSet
```
Get-AzRoleAssignment -ServicePrincipalName <String> [-RoleDefinitionName <String>]
[-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-IncludeClassicAdministrators] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceGroupParameterSet
```
Get-AzRoleAssignment -ResourceGroupName <String> [-RoleDefinitionName <String>] [-IncludeClassicAdministrators]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ResourceParameterSet
```
Get-AzRoleAssignment -ResourceGroupName <String> -ResourceName <String> -ResourceType <String>
[-ParentResource <String>] [-RoleDefinitionName <String>] [-IncludeClassicAdministrators]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ScopeParameterSet
```
Get-AzRoleAssignment [-RoleDefinitionName <String>] -Scope <String> [-IncludeClassicAdministrators]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -426,6 +438,21 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -SkipClientSideScopeValidation
If specified, skip client side scope validation.

```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

Expand Down
44 changes: 32 additions & 12 deletions src/Resources/Resources/help/New-AzRoleAssignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,79 +26,84 @@ Please notice that this cmdlet will mark `ObjectType` as `Unknown` in output if
```
New-AzRoleAssignment -ObjectId <String> [-Scope <String>] -RoleDefinitionName <String> [-Description <String>]
[-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] [-AllowDelegation]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ResourceGroupWithObjectIdParameterSet
```
New-AzRoleAssignment -ObjectId <String> -ResourceGroupName <String> -RoleDefinitionName <String>
[-Description <String>] [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>]
[-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-AllowDelegation] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceWithObjectIdParameterSet
```
New-AzRoleAssignment -ObjectId <String> -ResourceGroupName <String> -ResourceName <String>
-ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-Description <String>]
[-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] [-AllowDelegation]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### RoleIdWithScopeAndObjectIdParameterSet
```
New-AzRoleAssignment -ObjectId <String> -Scope <String> [-Description <String>] [-Condition <String>]
[-ConditionVersion <String>] [-ObjectType <String>] -RoleDefinitionId <Guid> [-AllowDelegation]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ResourceGroupWithSignInNameParameterSet
```
New-AzRoleAssignment -SignInName <String> -ResourceGroupName <String> -RoleDefinitionName <String>
[-Description <String>] [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>]
[-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-AllowDelegation] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceWithSignInNameParameterSet
```
New-AzRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String>
-ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-Description <String>]
[-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] [-AllowDelegation]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ScopeWithSignInNameParameterSet
```
New-AzRoleAssignment -SignInName <String> [-Scope <String>] -RoleDefinitionName <String>
[-Description <String>] [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>]
[-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-AllowDelegation] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceGroupWithSPNParameterSet
```
New-AzRoleAssignment -ApplicationId <String> -ResourceGroupName <String> -RoleDefinitionName <String>
[-Description <String>] [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>]
[-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-AllowDelegation] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceWithSPNParameterSet
```
New-AzRoleAssignment -ApplicationId <String> -ResourceGroupName <String> -ResourceName <String>
-ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-Description <String>]
[-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>] [-AllowDelegation]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ScopeWithSPNParameterSet
```
New-AzRoleAssignment -ApplicationId <String> [-Scope <String>] -RoleDefinitionName <String>
[-Description <String>] [-Condition <String>] [-ConditionVersion <String>] [-ObjectType <String>]
[-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
[-AllowDelegation] [-SkipClientSideScopeValidation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### InputFileParameterSet
```
New-AzRoleAssignment -InputFile <String> [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
New-AzRoleAssignment -InputFile <String> [-AllowDelegation] [-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -452,6 +457,21 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -SkipClientSideScopeValidation
If specified, skip client side scope validation.

```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

Expand Down
Loading
Loading