Share via


Remove-SPOServicePrioritizationBillingPolicy

Removes all app registrations linked to a SharePoint Online Service Prioritization billing policy and then deletes the billing policy itself.

Syntax

Default (Default)

Remove-SPOServicePrioritizationBillingPolicy
    -PolicyId <Guid>
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

This cmdlet removes all app registrations associated with the specified billing policy in a single server-side operation, and then deletes the billing policy from Azure Resource Manager.

The billing policy is only deleted if all linked app registrations were successfully removed. If any registrations could not be confirmed as deleted, the billing policy is left intact and the unconfirmed app IDs are reported in FailedAppIds.

By default, the cmdlet prompts for confirmation before deleting. Use -Force to suppress the confirmation prompt.

You must be a SharePoint Online administrator to run this cmdlet.

Examples

Example 1

Remove-SPOServicePrioritizationBillingPolicy -PolicyId 11111111-1111-1111-1111-111111111111

Example 1 prompts for confirmation, then removes all app registrations linked to the specified billing policy and deletes the billing policy.

Example 2

Remove-SPOServicePrioritizationBillingPolicy -PolicyId 11111111-1111-1111-1111-111111111111 -Force

Example 2 removes all app registrations linked to the specified billing policy and deletes the billing policy without prompting for confirmation.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Suppresses the confirmation prompt. Without this switch, the cmdlet displays the number of app registrations and billing policy that will be deleted and requires confirmation before proceeding.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PolicyId

The unique identifier of the SPO Service Prioritization billing policy to remove.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object

Notes

If BillingPolicyDeleted is false and FailedAppIds is null, the app registrations were removed but the billing policy itself could not be deleted. The billing policy may need to be removed manually.