Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Remove-AzADSpCredential
- Module:
- Az.Resources Module
Removes key credentials or password credentials for an service principal.
Syntax
ObjectIdWithKeyIdParameterSet (Default)
Remove-AzADSpCredential
-ObjectId <String>
[-KeyId <Guid>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SPNWithKeyIdParameterSet
Remove-AzADSpCredential
-ServicePrincipalName <String>
[-KeyId <Guid>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DisplayNameWithKeyIdParameterSet
Remove-AzADSpCredential
-DisplayName <String>
[-KeyId <Guid>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ServicePrincipalObjectParameterSet
Remove-AzADSpCredential
-ServicePrincipalObject <IMicrosoftGraphServicePrincipal>
[-KeyId <Guid>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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
-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
-DisplayName
The display name of service principal.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KeyId
The key Id of credentials to be removed.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ObjectId
The object Id of service principal.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Id |
Parameter sets
-PassThru
Returns true when the command succeeds
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ServicePrincipalName
The service principal name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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
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
Azure PowerShell
Feedback
Was this page helpful?