< Back
Remove-AzureRmADAppCredential
Post
NAME Remove-AzureRmADAppCredential
SYNOPSIS
Removes a credential from an application.
SYNTAX
Remove-AzureRmADAppCredential -All [-DefaultProfile <IAzureContextContainer>] [-Force] -ObjectId <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureRmADAppCredential -All -ApplicationId <String> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-AzureRmADAppCredential -ApplicationId <String> [-DefaultProfile <IAzureContextContainer>] [-Force] -KeyId <Guid> [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-AzureRmADAppCredential [-DefaultProfile <IAzureContextContainer>] [-Force] -KeyId <Guid> -ObjectId <String> [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Remove-AzureRmADAppCredential cmdlet can be used to remove a credential key from an application in the case of a compromise or as part of
credential key rollover expiration. The application is identified by supplying either the object ID or AppId. The credential to be removed is
identified by its key ID if an individual credential is to be removed or with an 'All' switch to delete all credentials associated with the
application.
PARAMETERS
-All [<SwitchParameter>]
Switch to remove all the credentials associated with the application.
Required? true
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ApplicationId <String>
The id of the application to remove the credentials from.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Switch to delete credential without a confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-KeyId <Guid>
Specifies the credential key to be removed. The key Ids for the application can be obtained using the Get-AzureRmADAppCredential cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ObjectId <String>
The object id of the application to remove the credentials from.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
NOTES
Example 1
PS E:\\> Remove-AzureRmADAppCredential -ObjectId 7663d3fb-6f86-4352-9e6d-cf9d50d5ee82 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb
This command removes a credential key from an application. In this example, the key with Id "9044423a-60a3-45ac-9ab1-09534157ebb" will be removed
from the application.
Example 2
PS E:\\> Remove-AzureRmADAppCredential -ApplicationId 4589cd6b-3d79-4bb4-93b8-a0b99f3bfc58 -All
This command removes a credential key from an application. In this example, all credentials will be removed from the application associated with
the applicationId "4589cd6b-3d79-4bb4-93b8-a0b99f3bfc58".
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... credential
Get-AzureRmADAppCredential
New-AzureRmADAppCredential
Get-AzureRmADApplication
SYNOPSIS
Removes a credential from an application.
SYNTAX
Remove-AzureRmADAppCredential -All [-DefaultProfile <IAzureContextContainer>] [-Force] -ObjectId <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureRmADAppCredential -All -ApplicationId <String> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-AzureRmADAppCredential -ApplicationId <String> [-DefaultProfile <IAzureContextContainer>] [-Force] -KeyId <Guid> [-Confirm] [-WhatIf]
[<CommonParameters>]
Remove-AzureRmADAppCredential [-DefaultProfile <IAzureContextContainer>] [-Force] -KeyId <Guid> -ObjectId <String> [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Remove-AzureRmADAppCredential cmdlet can be used to remove a credential key from an application in the case of a compromise or as part of
credential key rollover expiration. The application is identified by supplying either the object ID or AppId. The credential to be removed is
identified by its key ID if an individual credential is to be removed or with an 'All' switch to delete all credentials associated with the
application.
PARAMETERS
-All [<SwitchParameter>]
Switch to remove all the credentials associated with the application.
Required? true
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ApplicationId <String>
The id of the application to remove the credentials from.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Switch to delete credential without a confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-KeyId <Guid>
Specifies the credential key to be removed. The key Ids for the application can be obtained using the Get-AzureRmADAppCredential cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ObjectId <String>
The object id of the application to remove the credentials from.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
NOTES
Example 1
PS E:\\> Remove-AzureRmADAppCredential -ObjectId 7663d3fb-6f86-4352-9e6d-cf9d50d5ee82 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb
This command removes a credential key from an application. In this example, the key with Id "9044423a-60a3-45ac-9ab1-09534157ebb" will be removed
from the application.
Example 2
PS E:\\> Remove-AzureRmADAppCredential -ApplicationId 4589cd6b-3d79-4bb4-93b8-a0b99f3bfc58 -All
This command removes a credential key from an application. In this example, all credentials will be removed from the application associated with
the applicationId "4589cd6b-3d79-4bb4-93b8-a0b99f3bfc58".
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... credential
Get-AzureRmADAppCredential
New-AzureRmADAppCredential
Get-AzureRmADApplication