Skip to content

Remove-PBIWorkspace

SYNOPSIS

Remove workspaces and associated AD security groups in the Power BI service.

SYNTAX

Remove-PBIWorkspace [-WorkspaceName] <String[]> [-taskNumber] <Int32> [-force] [<CommonParameters>]

DESCRIPTION

This function removes specified workspaces from the Power BI service and deletes associated Active Directory security groups. Authentication is performed using Entra ID Service Principals, requiring appropriate permissions in PasswordState. The function also supports a force option to bypass confirmation prompts.

EXAMPLES

EXAMPLE 1

Remove-PBIWorkspace -WorkspaceName "Finance" -TaskNumber 12345

Removes the "Finance" workspace and its associated AD security groups.

EXAMPLE 2

Remove-PBIWorkspace -WorkspaceName "CRM Sales" -TaskNumber 67890 -Force

Removes the "CRM Sales" workspace and its associated AD security groups without confirmation.

PARAMETERS

-WorkspaceName

The name(s) of the workspace(s) to be removed. Workspace names are case-sensitive.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-taskNumber

The task number associated with the removal of the workspace, used for logging purposes.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-force

A switch to force the deletion of workspaces and associated groups without confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
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.

INPUTS

OUTPUTS

NOTES