Rename-PBIWorkspace
SYNOPSIS
Rename workspaces and associated AD security groups in the Power BI service.
SYNTAX
Rename-PBIWorkspace [-WorkspaceName] <String[]> [-NewWorkspaceName] <String[]> [-taskNumber] <Int32>
[-CRMWorkspace] [<CommonParameters>]
DESCRIPTION
This function renames specified workspaces in the Power BI service and updates associated Active Directory security groups. Authentication is performed using Azure Service Principals, requiring appropriate permissions in PasswordState. The function also handles CRM-specific workspaces by adding a "CRM" prefix if necessary.
EXAMPLES
EXAMPLE 1
Renames the "Finance" workspace to "FinanceDept" and updates associated AD security groups.
EXAMPLE 2
Rename-PBIWorkspace -WorkspaceName "CRM Sales" -NewWorkspaceName "CRM Sales Team" -CRMWorkspace -TaskNumber 67890
Renames the "CRM Sales" workspace to "CRM Sales Team" and ensures the "CRM" prefix is applied.
PARAMETERS
-WorkspaceName
The current name(s) of the workspace(s) to be renamed.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-NewWorkspaceName
The new name(s) for the workspace(s).
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-taskNumber
The task number associated with the renaming of the workspace, used for logging purposes.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-CRMWorkspace
A switch to indicate if the workspace is a CRM workspace. If enabled, a "CRM" prefix is added to the workspace name.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: False
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.