Edit

Share via

Remove-EntraServicePrincipalPasswordCredential

Module:
Microsoft.Entra Module v1.1

Removes a password credential from a service principal.

Syntax

Default (Default) 

Remove-EntraServicePrincipalPasswordCredential

    -ServicePrincipalId <String>
    -KeyId <String>
    [<CommonParameters>]

Description

The Remove-EntraServicePrincipalPasswordCredential cmdlet removes a password credential from a service principal in Microsoft Entra ID.

Examples

Example 1: Remove a password credential from a service principal in Microsoft Entra ID

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$servicePrincipal = Get-EntraServicePrincipal -Filter "displayName eq 'Helpdesk Application'"
$key = Get-EntraServicePrincipalPasswordCredential -ServicePrincipalId $servicePrincipal.Id
$key = $key | Where-Object {$_.DisplayName -eq 'Helpdesk secret'}
Remove-EntraServicePrincipalPasswordCredential -ServicePrincipalId $servicePrincipal.Id -KeyId $key.KeyId

This example demonstrates how to remove a password credential from a service principal in Microsoft Entra ID.

  • -ServicePrincipalId parameter specifies the ServicePrincipalId of a specified Service Principal Password Credential.
  • -KeyId parameter specifies the unique identifier of a Password Credential.

Parameters

-KeyId

Specifies the unique identifier of password credential.

Parameter properties

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

Parameter sets

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

-ServicePrincipalId

Specifies the ID of an application in Microsoft Entra ID.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ObjectId

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
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.