Edit

Remove-AzADSpCredential

Module:
Az.Resources Module

Removes key credentials or password credentials for an service principal.

Syntax

ObjectIdWithKeyIdParameterSet (Default) 

Remove-AzADSpCredential
    -ObjectId 
    [-KeyId ]
    [-DefaultProfile ]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    []

SPNWithKeyIdParameterSet 

Remove-AzADSpCredential
    -ServicePrincipalName 
    [-KeyId ]
    [-DefaultProfile ]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    []

DisplayNameWithKeyIdParameterSet 

Remove-AzADSpCredential
    -DisplayName 
    [-KeyId ]
    [-DefaultProfile ]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    []

ServicePrincipalObjectParameterSet 

Remove-AzADSpCredential
    -ServicePrincipalObject 
    [-KeyId ]
    [-DefaultProfile ]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    []

Description

Removes key credentials or password credentials for an service principal.

Examples

Example 1: Remove service principal credentials by key id

Remove-AzADSpCredential -DisplayName $name -KeyId $keyid

Remove service principal credentials by key id

Example 2: Remove all credentials from service principal

Get-AzADServicePrincipal -DisplayName $name | Remove-AzADSpCredential

Remove all credentials from service principal

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

-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

The display name of service principal.

Parameter properties

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

Parameter sets

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

-KeyId

The key Id of credentials to be removed.

Parameter properties

Type:Guid
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

-ObjectId

The object Id of service principal.

Parameter properties

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

Parameter sets

ObjectIdWithKeyIdParameterSet
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

The service principal name.

Parameter properties

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

Parameter sets

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

-ServicePrincipalObject

The service principal object, could be used as pipeline input.

Parameter properties

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

Parameter sets

ServicePrincipalObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
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

IMicrosoftGraphServicePrincipal

Outputs

Boolean

Notes

ALIASES

Remove-AzADServicePrincipalCredential