Share via


Remove-AllowedConsentPlans

Removes all consent plans of the specified types from the tenant and blocks consent plans of those type from being created within the tenant.

Syntax

Default (Default)

Remove-AllowedConsentPlans
    [-Types] <String[]>
    [[-Prompt] <Boolean>]
    [[-ApiVersion] <String>]
    [<CommonParameters>]

Description

The Remove-AllowedConsentPlans cmdlet removes consent plans of the specified types from the tenant and blocks consent plans of those type from being created within the tenant. Note that this only impacts the types specified, all others will be unaffected. Use Get-Help Remove-AllowedConsentPlans -Examples for more detail.

Examples

EXAMPLE 1

Remove-AllowedConsentPlans -Types @("Internal", "Viral")

Removes consent plans of type internal and viral.

Parameters

-ApiVersion

The api version to call with. Default 2016-11-01

Parameter properties

Type:String
Default value:2019-05-01
Supports wildcards:False
DontShow:False

Parameter sets

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

-Prompt

Prompt when removing consent plans by confirmation.

Parameter properties

Type:Boolean
Default value:True
Supports wildcards:False
DontShow:False

Parameter sets

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

-Types

The types of consent plans that should be removed. Valid options are Internal, Viral.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
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.