Edit

Share via


Remove-AzADServicePrincipal

Deletes entity from service principal.

Syntax

ObjectIdParameterSet (Default)

Remove-AzADServicePrincipal
    -ObjectId <String>
    [-IfMatch <String>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ApplicationIdParameterSet

Remove-AzADServicePrincipal
    -ApplicationId <Guid>
    [-IfMatch <String>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SPNParameterSet

Remove-AzADServicePrincipal
    -ServicePrincipalName <String>
    [-IfMatch <String>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DisplayNameParameterSet

Remove-AzADServicePrincipal
    -DisplayName <String>
    [-IfMatch <String>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectParameterSet

Remove-AzADServicePrincipal
    -InputObject <IMicrosoftGraphServicePrincipal>
    [-IfMatch <String>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ApplicationObjectParameterSet

Remove-AzADServicePrincipal
    -ApplicationObject <IMicrosoftGraphApplication>
    [-IfMatch <String>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Deletes entity from service principal.

Examples

Example 1: Remove service principal by display name

Remove-AzADServicePrincipal -DisplayName $name

Remove service principal by display name

Example 2: Remove service principal by pipeline input

Get-AzADServicePrincipal -ApplicationId $id | Remove-AzADServicePrincipal

Remove service principal by pipeline input

Parameters

-ApplicationId

key: application id

Parameter properties

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

Parameter sets

ApplicationIdParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ApplicationObject

key: application object

Parameter properties

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

Parameter sets

ApplicationObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

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

-DisplayName

key: display name

Parameter properties

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

Parameter sets

DisplayNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IfMatch

ETag

Parameter properties

Type:String
Default value:None
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

-InputObject

key: service principal object

Parameter properties

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

Parameter sets

InputObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ObjectId

key: id of servicePrincipal

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ServicePrincipalId, Id, PrincipalId

Parameter sets

ObjectIdParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:SwitchParameter
Default value:None
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

-ServicePrincipalName

key: service principal name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SPN

Parameter sets

SPNParameterSet
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

IMicrosoftGraphApplication

IMicrosoftGraphServicePrincipal

Outputs

Boolean